Techdocs default mkdoc.yaml for all documentation directories #102
Description
Version:
'RoadieHQ/[email protected]'
What happened
This is related to #69
Starting from version 1.11.0, Backstage now includes a default mkdoc.yaml file. backstage/backstage#15417
This default mkdoc.yaml file will be used for all tech doc directories, not only for dir:..
Expected Behavior
Specifying a directory that does not have a mkdoc.yml or mkdoc.yaml file by using the annotation backstage.io/techdocs-ref: should not cause an error as Backstage would use a default mkdoc file in this case.
Current Behavior
Specifying a directory (that does not include a mkdoc file) that is different from the root directory gives the following error:
Error: Action failed with error: Error: Techdocs annotation specifies "dir" but file under templates/healthcare/mkdocs.yaml|templates/healthcare/mkdocs.yml not found
Steps to Reproduce
Make the backstage.io/techdocs-ref: annotation point to a directory that is not the root directory and that does not have any mkdoc files.
This documentation is being correctly displayed in Backstage, however, the catalog validator fails.
Possible Solution
Remove this validation as it is no longer necessary. This is where the validation is being done: https://github.com/RoadieHQ/roadie-backstage-plugins/blob/main/utils/roadie-backstage-entity-validator/src/relativeSpaceValidation.js