Create new Contribute to docs section, move existing content
#3230
Conversation
This file contains hidden or 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
leemthompo
added a commit
to elastic/docs-builder
that referenced
this pull request
Sep 30, 2025
leemthompo
added
Initiative 🚀
documentation
theletterf
approved these changes
Sep 30, 2025
lcawl
reviewed
Oct 2, 2025
contribute-docs/toc.yml
Outdated
| @@ -0,0 +1,11 @@ | |||
| toc: | |||
| - file: index.md | |||
| - file: api-docs/index.md | |||
There was a problem hiding this comment.
- file: api-docs/index.md
This seems like a duplication of what's in the api-docs/toc.yml file. Is the duplication necessary?
There was a problem hiding this comment.
good catch, I actually had a failing all-repo build when I didn't do this duplication
but maybe I could restructure somewhere else?
Mpdreamz
requested changes
Oct 3, 2025
contribute-docs/toc.yml
Outdated
Comment on lines
3
to
11
| - file: api-docs/index.md | ||
| children: | ||
| - file: api-docs/overview.md | ||
| - file: api-docs/checklist.md | ||
| - file: api-docs/guidelines.md | ||
| - file: api-docs/organize-annotate.md | ||
| - file: api-docs/quickstart.md | ||
| - file: api-docs/workflows.md | ||
| - file: api-docs/help.md No newline at end of file |
There was a problem hiding this comment.
Suggested change
| - file: api-docs/index.md | |
| children: | |
| - file: api-docs/overview.md | |
| - file: api-docs/checklist.md | |
| - file: api-docs/guidelines.md | |
| - file: api-docs/organize-annotate.md | |
| - file: api-docs/quickstart.md | |
| - file: api-docs/workflows.md | |
| - file: api-docs/help.md | |
| - folder: api-docs | |
| children: | |
| - file: index.md | |
| - file: overview.md | |
| - file: checklist.md | |
| - file: guidelines.md | |
| - file: organize-annotate.md | |
| - file: quickstart.md | |
| - file: workflows.md | |
| - file: help.md |
Remove api-docs/toc.yml if you do not intend to place the api-docs/toc.yml some place different then under contribute-docs/api-docs as defined here:
There was a problem hiding this comment.
ah ha! I knew something was off with that duplication
thanks @Mpdreamz
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.
Contributes to https://github.com/elastic/docs-content-internal/issues/334
I validated with a full docs-builder build locally
Summary
• Created top-level
contribute-docs/section - New main section for public docs contribution guidelines• Moved API docs guidelines from
extend/contribute/api-docs/tocontribute-docs/api-docs/• Updated
docset.yml- Addedtoc: contribute-docsto main navigation• Updated
extend/toc.yml- Removed references to moved files, simplified structure• Added redirects - All old URLs redirect to new locations
• Created new TOC files -
contribute-docs/toc.ymlandcontribute-docs/api-docs/toc.ymlRelated PR in
docs-builderelastic/docs-builder#1969