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

Backport doc fixes for libbeat. #6880

Merged
merged 2 commits into from Apr 17, 2018

Conversation

Projects
None yet
4 participants
@simitt
Copy link
Contributor

simitt commented Apr 17, 2018

Backports some changes to beats 6.2, mostly necessary for APM Server doc updates.

@simitt simitt requested a review from ruflin Apr 17, 2018

@simitt simitt closed this Apr 17, 2018

roncohen and others added some commits Feb 22, 2018

More generic docs for use in APM Server (#6184)
* Use specific beat name's instead of 'the Beat'
* Dont show Logstash info unless it's supported.
* Make the index pattern decoupled from the beat name
* Make it possible to skip the pipeline docs in output.elasticsearch
* Introduce beat_default_index_prefix.
* Use name of beat in shared-kibana-config.asciidoc
* Add .\ for PS instruction and make it possible to remove logstash mention.
* Introduce 'has_ml_jobs'
* Added `html_docs` to .gitignore
* Better outputconfig for Elasticsearch only beats.
* Less blamy wording
* Only talk about Filebeat for filebeat docs
* Update the rest of the max_retries sections to only talk about Filebeat for filebeat
* Special case for apm-server as it was only introduced in 6.0
* expand beat_default_index_prefix use (#2)
Backport docs changes.
Minor adaptions for getting-help and
command-reference sections.

@simitt simitt reopened this Apr 17, 2018

@simitt simitt force-pushed the simitt:6.2-docs-update branch from 4e92b2c to bf3fcba Apr 17, 2018

@ruflin

ruflin approved these changes Apr 17, 2018

:github_repo_name: beats
:discuss_forum: beats/{beatname_lc}
:beat_default_index_prefix: {beatname_lc}
:has_ml_jobs: yes

This comment has been minimized.

Copy link
@ruflin

ruflin Apr 17, 2018

Collaborator

@dedemorton This is only the backport of the PR so not directly related to this PR but it seems we have has_ml_jobs set to yes for all beats but they only exist in Filebeat. Should we turn it off for the other beats?

This comment has been minimized.

Copy link
@dedemorton

dedemorton Apr 17, 2018

Contributor

@ruflin I think that's one of the conditions the apm team added. I'll explore some more and follow up.

This comment has been minimized.

Copy link
@simitt

simitt Apr 18, 2018

Author Contributor

Afaik before adding this the docs showed the machine learning related information for every beat. Introducing this variable enabled us to avoid having notes about machine learning in the APM docs. As we didn't want to change any semantics for beats though, the variable was set to true for all beats.

@ruflin ruflin merged commit 29df70d into elastic:6.2 Apr 17, 2018

2 of 4 checks passed

continuous-integration/travis-ci/pr The Travis CI build could not complete due to an error
Details
beats-ci Build started sha1 is merged.
Details
CLA Commit author is a member of Elasticsearch
Details
Hound No violations found. Woof!

@simitt simitt deleted the simitt:6.2-docs-update branch Dec 22, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.