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

Clean up Documentation #30

Open
6 tasks
josephlewis42 opened this issue May 31, 2018 · 0 comments
Open
6 tasks

Clean up Documentation #30

josephlewis42 opened this issue May 31, 2018 · 0 comments

Comments

@josephlewis42
Copy link
Contributor

The documentation for this plugin could be greatly improved. General steps to achieve it:

  • Remove documentation in code, this is no longer recommended for new Logstash plugins because it leads to out-of-sync docs.
  • Make the example config runnable if the user copy/pastes, right now it has extra info (required), (optional) which need to be deleted
  • Provide example configuration for common use-cases to onboard faster and provide guidelines.
  • Add a section for extra resources including pricing, different storage types, ADC and service accounts.
  • Add documentation about minimal service account permissions needed to run the plugin.
  • Remove the TODOs/feature requests and add them as issues in Github.
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

1 participant