Skip to content

[docs] More updates for docs-assembler #125509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Mar 24, 2025
Merged

[docs] More updates for docs-assembler #125509

merged 4 commits into from
Mar 24, 2025

Conversation

@colleenmcginnis
Copy link
Contributor

Adds a reference/toc.yml file, move individual reference toc entries from docset.yml to the new reference/toc.yml file. This also moves the intro content from docs-content to this repo so the intro can be at elastic.co/docs/reference/elasticsearch/.

@colleenmcginnis colleenmcginnis added >docs General docs changes Team:Docs Meta label for docs team labels Mar 24, 2025
@elasticsearchmachine elasticsearchmachine added v9.1.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Mar 24, 2025
@colleenmcginnis colleenmcginnis marked this pull request as ready for review March 24, 2025 15:54
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

colleenmcginnis
colleenmcginnis commented Mar 24, 2025
View reviewed changes
leemthompo
leemthompo approved these changes Mar 24, 2025
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🦭

@colleenmcginnis colleenmcginnis mentioned this pull request Mar 24, 2025
Merged
@Mpdreamz
Copy link
Member

I did spot the root name is correct now:

image

And the breaking changes sub pages are named incorrectly.

Unrelated to this PR though

Mpdreamz
Mpdreamz requested changes Mar 24, 2025
View reviewed changes
docs/reference/toc.yml
@@ -0,0 +1,10 @@
toc:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs an index.yml file.

@colleenmcginnis
Copy link
Contributor Author

I'm confused why I'm getting an error now... isn't this the pattern we used in https://github.com/elastic/docs-content/pull/897/files#diff-638bebef2d25c4bc8b59b234b825533f78bad25e4422581025d60f78a4ccc770? I must be missing something else.

@Mpdreamz
Copy link
Member

@colleenmcginnis we still need toc_max_depth in the config to enable multiple levels of toc definitions.

https://github.com/elastic/docs-content/blob/main/docset.yml#L2

@colleenmcginnis
Copy link
Contributor Author

Is this not the right spot for it? https://github.com/elastic/elasticsearch/pull/125509/files#diff-165b79089c3088414476471a320e02688a45f8a6d2d94fbc784ceae8ad5cae04R2

@Mpdreamz
Copy link
Member

Ahh this check in docs-builder is overly restrictive.

It only allows a mix of file and toc in the docs-builder and docs-content repositories:

https://github.com/elastic/docs-builder/blob/7785afd41a6c7bc54f928c586b127a6a16b02378/src/Elastic.Markdown/IO/Configuration/TableOfContentsConfiguration.cs#L85

Will add a fix.

@Mpdreamz
Copy link
Member

That fixed it :)

@colleenmcginnis colleenmcginnis merged commit 162763b into elastic:main Mar 24, 2025
6 checks passed
@colleenmcginnis colleenmcginnis deleted the docs-assembler-part-2 branch March 24, 2025 19:24
@colleenmcginnis colleenmcginnis mentioned this pull request Mar 24, 2025
Closed
3 tasks
omricohenn pushed a commit to omricohenn/elasticsearch that referenced this pull request Mar 28, 2025
@colleenmcginnis @omricohenn
[docs] More updates for docs-assembler (elastic#125509)
00e1f4b 
* update docset.yml, add reference/toc.yml, update reference/elasticsearch/index.md

* Update docs/docset.yml

* add index.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mpdreamz Mpdreamz Mpdreamz approved these changes

@leemthompo leemthompo leemthompo approved these changes

Assignees

No one assigned

Labels

>docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@colleenmcginnis @elasticsearchmachine @Mpdreamz @leemthompo