Skip to content

Cleanup for versioned plugin docgen #9048

@dedemorton

Description

@dedemorton

Remaining tasks:

  • Cleanup of source files also described here
    a) massively apply the data type link conversions to all plugins (example PR for 1 plugin that addresses only the data type conversions: [WIP] convert data type links in docs logstash-plugins/logstash-output-elasticsearch#728)
    b) fix the remaining broken docs for these 26 plugins - (already merged plugins listed in auto generated docs for latest plugin versions logstash-docs#463)
    c) mass release plugins with doc changes
  • Modify the version plugin gen script so that the include_path gets set to :include_path: ../include/6.x. We'll need to search/replace until the script is fixed. NOTE that the include paths in the plugins folder (for main Logstash Ref) need to stay as-is for the LS Reference build to work.
  • Need a plan for running the script periodically to publish new versions of the plugins.
  • [DeDe] Add info about generating the plugin docs (the plugins for the Logstash Ref and the Versioned LS Plugin Reference (where the files live, what the tool does, and how generate the files and build the books). Should probably have an overall doc that talks about generating plugin docs and add a section about the versioned docs.
  • Automate the generation of the versioned documentation so that a new version of the docs is generated/published whenever a new version of a plugin is released.

Outstanding problems to solve:

  • In the VPR, we use the logstash-ref attribute in the index.asciidoc file to set the URL for links that point to the Logstash Reference (:logstash-ref: http://www.elastic.co/guide/en/logstash). These links will break over time as we add content. At some point, we need to use versioned links so that the VPR points to whatever version of the Logstash Reference was current when the plugin was released. To do this, the docgen script would need to add an attribute that overrides the path. So, along with the other attributes that the docgen adds, it would add something like the following to each generated file: :logstash-ref: http://www.elastic.co/guide/en/logstash/7.0.
  • Versioning of common files. When common files change, need to create a new folder at the same level as include/6.x and have the script set the include_path attribute to point to the branch for any new files that it generates.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions