Description
The X-Pack-specific documentation currently resides in https://github.com/elastic/elasticsearch/tree/master/x-pack/docs, but in the long term (now that X-Pack is installed with Elasticsearch), that separation is not required.
The Elasticsearch Reference documentation builds (and navigation tree) will be simpler if we no longer have to pull content from these separate directories.
The following items would need to be addressed:
-
Ensuring that X-Pack-related code snippets can be tested successfully after the move. Does this mean that we need a way to flag code snippets that involve non-Basic features? Related to https://github.com/elastic/infra/issues/5608, Docs: Use the default distribution to test docs #31251, QA: Create xpack yaml features #31403, [DOCS] Re-enable code snippet testing for rollup APIs #33319.
-
Can we stop generating OSS-only versions of the Elasticsearch Reference? They have not been provided on the web for a while now. If we can cease providing a method to generate OSS-only versions of the book, it avoids the need for complicated include flags. See [DOCS] Removes redundant index.asciidoc files #30707
-
Identifying where in the table of contents to integrate the pages that currently exist under the "Setup X-Pack", "X-Pack APIs", and "X-Pack Commands" sections. See [DOCS] Moves X-Pack configuration pages in table of contents #30702
-
Addressing broken links and creating redirects for all pages that are deleted or moved.
-
Determining whether it is still necessary to highlight pages that contain X-Pack-specific content. Or perhaps only identify information pertaining to non-Basic X-Pack features? Currently, all X-Pack info has an icon next to the page or section title. For example:
Add "en" folder under elasticsearch/docs? This currently exists in the elasticsearch/x-pack/docs folder and was added to accommodate translation.
See also elastic/kibana#19156 and elastic/logstash#9596