Skip to content

Merge x-pack/docs into docs #9596

@lcawl

Description

@lcawl

The X-Pack-specific documentation currently resides in https://github.com/elastic/logstash/tree/master/x-pack/docs, but in the long term (now that X-Pack is installed with Logstash), that separation is not required.

The Logstash 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? N/A, since testing is not enabled yet.

  • Can we stop generating OSS-only versions of the Logstash 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 #9607 and [DOCS] Replaces OSS-only doc build command aliases docs#354

  • Identifying where in the table of contents to integrate the pages that currently exist under the "Setting up X-Pack" section. Do they work under the "Setting up and running Logstash" section? See [DOCS] Moves X-Pack configuration pages in table of contents #9604

  • 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:
    xpack-icon-logstash

  • Add "en" folder under logstash/docs (to contain all the existing english content there)? This currently exists in the logstash/x-pack/docs folder and was added to accommodate translation. This can be added if necessary later.

See also elastic/kibana#19156 and elastic/elasticsearch#30665

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions