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

Remove setup and run steps from the docs for individual modules #16475

Closed
dedemorton opened this issue Feb 21, 2020 · 0 comments · Fixed by #16571
Closed

Remove setup and run steps from the docs for individual modules #16475

dedemorton opened this issue Feb 21, 2020 · 0 comments · Fixed by #16571
Assignees
Labels

Comments

@dedemorton
Copy link
Contributor

dedemorton commented Feb 21, 2020

Describe the enhancement:

  • Remove the setup and run steps from topics that describe module configuration.

  • Check the module generator to see if it required updates, too

  • While we have the files open, add conditional coding so we can suppress content that's not relevant when using observability UIs--we'll need this later.

EDITED: Removing the last item because it sounds like the more granular dashboards will be necessary at least for awhile.

Background: Many moons ago we added setup instructions to the Filebeat modules documentation to support product pages that pointed directly to the module docs (but didn't have setup instructions). Users needed the context. Fast forward to now, and we have Add Data pages that walk users through the setup. The steps for setting up and running Filebeat with the module enabled are no longer required. In fact, they make it harder to find the config info that users are looking for.

Describe a specific use case for the enhancement or feature:
Users go to the Add Data pages and run through the module setup steps. If they go to the docs about the module, they want to see what configuration options are available, but instead they see a list of steps that they've already performed. Removing the setup/run steps will make it easier for users to find the info they're looking for.

@dedemorton dedemorton self-assigned this Feb 21, 2020
@dedemorton dedemorton changed the title Remove setup and run steps from the Filebeat module docs Remove setup and run steps from the docs for individual modules Feb 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant