fix(mkdocs): structure according best practices #442
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change structures mkdocs according to their [recommended file layout][mkdocs-file-layout]. This moves `mkdocs.yml` to the root of the project, alongside the `docs/` directory. Also, update the `catalog-info.yml`'s `backstage.io/techdocs-ref` annotation to `.`. Backstage [strongly recommends `techdocs-ref` annotation to be set to `dir:.` in almost all situations][backstage-techdocs-ref]. [mkdocs-file-layout]: https://www.mkdocs.org/user-guide/writing-your-docs/#file-layout [backstage-techdocs-ref]: https://backstage.io/docs/features/techdocs/how-to-guides/#how-to-understand-techdocs-ref-annotation-values
|
Heh, exactly my PR: #441 |
malcolmholmes
approved these changes
May 9, 2024
|
Can you fix the refs in the workflow file like I did in here: #441 |
Oh yea good catch! Will do. |
This should now be run in the root rather than inside the `docs/` dir. Also update paths for when workflow should run. Also fix comment for serving mkdocs locally
zzehring
force-pushed
the
zzehring/docs/fix-structure-for-mkdocs
branch
from
be282cd to
74d3d39
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change structures mkdocs according to their recommended file layout. This moves
mkdocs.ymlto the root of the project, alongside thedocs/directory.Also, update the
catalog-info.yml'sbackstage.io/techdocs-refannotation to.. Backstage strongly recommendstechdocs-refannotation to be set todir:.in almost all situations.