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

Update docs #7164

Merged
merged 1 commit into from
May 29, 2018
Merged

Update docs #7164

merged 1 commit into from
May 29, 2018

Conversation

simitt
Copy link
Contributor

@simitt simitt commented May 23, 2018

  • Only refer to beat.reference.yml in the official docs for the beats that actually have a reference.yml.
  • Add missing config option output.elasticsearch.ssl.client_authentication to reference.yml files that has been documented already on the official beats docs pages.

@simitt
Copy link
Contributor Author

simitt commented May 23, 2018

@ruflin could you please verify that adding the output.elasticsearch.ssl.client_authentication to the reference.yml files is ok. When I updated the docs in apm-server I realized that this option was added to the official docs but not to the reference yml files.

@ph
Copy link
Contributor

ph commented May 23, 2018 via email

@simitt
Copy link
Contributor Author

simitt commented May 23, 2018

@ph could you please ping me on the PR, so I can also update for the APM Server.

@simitt simitt changed the title Update docs and reference yml Update docs May 23, 2018
@simitt
Copy link
Contributor Author

simitt commented May 29, 2018

@ruflin could you have a look at this PR please.

ifeval::["{beatname_lc}"!="auditbeat"]
For rpm and deb, you'll find the configuration file at +/etc/{beatname_lc}/{beatname_lc}.yml+.
For mac and win, look in the archive that you just extracted.
Under Docker, it's located at +/usr/share/{beatname_lc}/{beatname_lc}.yml+.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I get this right the only difference for auditbeat is that it does not include the docker part? Could we have only an not auditbeat if clause for the docker part?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried that, but then it renders the docker part in a new paragraph, which I think looks weird.

@ruflin
Copy link
Member

ruflin commented May 29, 2018

@simitt LGTM. Left a minor comment. I think the logic is ok as you did it but it could be simplified.

@ruflin ruflin merged commit 7abc684 into elastic:master May 29, 2018
@simitt simitt deleted the update-docs branch December 22, 2018 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants