Consolidate docs files around contributing #5113
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
twz123
force-pushed
the
docs-consolidate-contributors
branch
from
28ccd09
to
6ddecee
Compare
twz123
commented
Oct 11, 2024
Comment on lines
+16
to
+22
| # ... other directives | ||
| {% | ||
| include "../../mkdocs.yml" | ||
| start="# ~~~ START NAV SNIPPET ~~~\n" | ||
| end="\n# ~~~ END NAV SNIPPET ~~~\n" | ||
| %} | ||
| # more navigation links ... |
twz123
force-pushed
the
docs-consolidate-contributors
branch
from
6ddecee
to
1a1ec67
Compare
jnummelin
previously approved these changes
Oct 28, 2024
|
This pull request has merge conflicts that need to be resolved. |
Also rename it to "Getting Started". Signed-off-by: Tom Wieczorek <[email protected]>
They're linked from there, so why not placing them there, as well. It's not considered internal documentation anyways if it's linked from the Contributor Guide. Signed-off-by: Tom Wieczorek <[email protected]>
Signed-off-by: Tom Wieczorek <[email protected]>
Use the include-markdown plugin to fetch the nav section directly into the docs page about how to add docs pages :-) Signed-off-by: Tom Wieczorek <[email protected]>
twz123
force-pushed
the
docs-consolidate-contributors
branch
from
1a1ec67
to
9d8ecc3
Compare
jnummelin
approved these changes
Oct 29, 2024
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.
Description
Make the contributing overview the index page
Also rename it to "Getting Started".
Move the docs docs to the contributors folder
They're linked from there, so why not placing them there, as well. It's not considered internal documentation anyways if it's linked from the Contributor Guide.
Include the mkdocs nav section directly
Use the include-markdown plugin to fetch the nav section directly into the docs page about how to add docs pages :-)
Don't include internal docs in the rendered documentation
Type of change
How Has This Been Tested?
Checklist: