[DOCS] Move x-pack docs to docs/reference dir
#99209
Conversation
|
Documentation preview: |
jrodewig
changed the title
reference dir
jrodewig
changed the title
reference dirdocs/reference dir
jrodewig
added
:Delivery/Build
elasticsearchmachine
added
Team:Data Management
|
Pinging @elastic/es-security (Team:Security) |
|
Pinging @elastic/es-delivery (Team:Delivery) |
|
Pinging @elastic/es-data-management (Team:Data Management) |
There was a problem hiding this comment.
Changes to this file are taken from https://github.com/elastic/elasticsearch/blob/main/x-pack/docs/build.gradle
There was a problem hiding this comment.
jrodewig
added
>docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Thanks @abdonpijpelink.
This isn't urgent (largely an ergonomics change) so I'll wait on a 👍 from @elastic/es-delivery before merging. |
| // These files simply don't pass yet. We should figure out how to fix them. | ||
| exclude 'reference/watcher/reference/actions.asciidoc' | ||
| exclude 'reference/rest-api/security/ssl.asciidoc' |
There was a problem hiding this comment.
| 'en/watcher/example-watches/watching-time-series-data.asciidoc', | ||
| ] | ||
| } | ||
| // tasks.named("buildRestTests").configure { |
There was a problem hiding this comment.
Should we remove this? in fact, can we remove the entire x-pack/docs project?
There was a problem hiding this comment.
Sorry — I left some sentences about this in the top-level comment, but I should have left one here as well.
The x-pack/docs directory is currently required for the docs build. I left these files here so that we don't break the build. I'll remove the x-pack/docs directory and these files after I merge this PR and update the docs build config. I already have related PRs drafted:
If wanted, I can update this PR to replace the files in the x-pack/docs directory with a placeholder txt file. The docs build only needs the directory to exist — even if it doesn't pull anything from it.
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
**Problem:** With elastic/elasticsearch#99209, the elasticsearch repo's `x-pack/docs` directory no longer contains docs for the Elasticsearch Guide in 8.10+. However, the docs build config still lists the `x-pack/docs` directory as a dependency. **Solution:** Update the docs build config to remove the `x-pack/docs` dependency for the Elasticsearch Guide in 8.10+. Depends on elastic/elasticsearch#99209 Rel: https://github.com/elastic/platform-docs-team/issues/208
**Problem:** With #99209, the elasticsearch repo's `x-pack/docs` directory no longer contains docs for the Elasticsearch Guide in 8.10+. The `gradle.build` files in the directory were only left in so that the docs build doesn't break. That's been fixed with elastic/docs#2753. **Solution:** Removes the `x-pack/docs` directory. Depends on #99209, elastic/docs#2753 Closes: https://github.com/elastic/platform-docs-team/issues/208
Problem:
For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the
x-pack/docsdirectory. This can confuse new contributors who expect Elasticsearch Guide docs to be located indocs/reference.Solution:
docs/referencedirectoryRel: https://github.com/elastic/platform-docs-team/issues/208
Notes for reviewers
I recommend reviewing this PR by commit.
This PR doesn't change any URLs. No redirects are needed.
I left the
x-pack/docsdirectory with related build.gradle files in for now. This directory is currently required for the docs build. I'll remove thex-pack/docsdirectory after I merge this PR and update the docs build config.