Skip to content
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.

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

Logstash 5.2 doc fixes #6501

Closed
13 tasks done
dedemorton opened this issue Jan 6, 2017 · 3 comments
Closed
13 tasks done

Logstash 5.2 doc fixes #6501

dedemorton opened this issue Jan 6, 2017 · 3 comments

Comments

@dedemorton
Copy link
Contributor

dedemorton commented Jan 6, 2017

5.2

  • Add docs for prepare-offline pack - see bin/logstash-plugin prepare-offline-pack, improvements to install a pack and rats tests. #6404
  • Pack and unpack are now deprecated and will be removed in 6.0
  • Document monitoring API additions:
  • [Deb] Add monitoring UI content to X-Pack docs - see https://github.com/elastic/x-pack/issues/4511
  • Add 5.2 release notes
  • Plugin docs enhancements (as plugin pages now show version, release date, changelog, and compatibility)
    • [moved to future list] "master" version of docs needs to be fixed to show latest version of all plugins. The other versions will continue to show the plugin version which was bundled with the release.
    • REMOVED FROM DOCS Compatibility currently shows all the different LS versions. To mitigate cost of continued maintenance, we could just show first and last versions e.g. "Logstash 2.4.0 - 5.1.2" with the latest version updating with each newest release. NOTE: As of Feb 6, the 5.2 docs do not yet show 5.2 as a compatible version!
    • "Released on" date using "mmm dd, yyyy" may be more human readable
    • Add "Installation" section: "For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-x-y. See the docs for more details."
    • Add "Getting Help" section: "For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix."

Moved backlog to this issue: #6724

@acchen97
Copy link
Contributor

acchen97 commented Jan 7, 2017

@dedemorton updated the original issue.

Plugin docs enhancements (as plugin pages now show version, release date, changelog, and compatibility)

  • "master" version of docs needs to be fixed to show latest version of all plugins. The other versions will continue to show the plugin version which was bundled with the release.
  • Compatibility currently shows all the different LS versions. To mitigate cost of continued maintenance, we could just show first and last versions e.g. "Logstash 2.4.0 - 5.1.2" with the latest version updating with each newest release.
  • "Released on" date using "mmm dd, yyyy" may be more human readable
  • Add "Installation" section: "For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-x-y. See the docs for more details."
  • Add "Getting Help" section: "For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix."

@ph @jordansissel included above are a couple enhancement requests for the plugin docs. The first and last items here are higher priority than the rest.

@dedemorton
Copy link
Contributor Author

@ph I thought the docgen script was going to add an installation section (see above). Did we decide not to do that after all? Just trying to close out the items from this list. I think the only remaining one is to update the docs in master (and automate the process), no?

@dedemorton
Copy link
Contributor Author

Closing this old issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants