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

Add configuration management topics to the Beats docs #9054

Merged
merged 5 commits into from
Nov 13, 2018

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Nov 13, 2018

Edits and adds content to the Beats to cover configuration management.

You can see the built docs on Firebase here: https://beatsmanagement-b2e5c.firebaseapp.com/configuration-central-management.html

A few notes:

  • Asciidoc can't seem to handle images added with includes, so I've had to copy the referenced images into the relevant image folders for each Beat. I'll investigate a better way of doing this, but I've gone down that rabbit hole before with no success.

  • I've used screen captures instead of conceptual diagrams, but I'd like to replace the screen captures at some point because they are likely to get out-of-date quickly, and I don't think screen captures are necessary to explain the concepts.

  • I've flagged the content with the x-pack badge, but I don't mention that a gold license is required because we've been told in the past to avoid mentioning specific licenses in the docs. Now that x-pack isn't being used, though, 🤷‍♀️ .

  • Our convention is to use uppercase instead of < > for variable values shown in syntax descriptions. we might change that, but for now, I've changed the command example to follow our contention.

  • Did a little restructuring, but we can change it later if it doens't work. I decided to pop the section up in the TOC because I felt that it was too hidden under the configuring topic. I will add links from those topics to point to the central management docs. I also broke the topic into several sections because I wanted to add a place where we can put the API docs later. Also, I wanted the topic about enrolling beats to have a higher SEO ranking.

  • I also plan to add a page to the Kibana docs to explain basic operations in the UI and point users to these docs.

@dedemorton dedemorton requested a review from exekias November 13, 2018 06:27
@dedemorton dedemorton added docs review needs_backport PR is waiting to be backported to other branches. labels Nov 13, 2018

// REVIEWERS: Thought it might be worth adding a container so users know that the
// there is an API, but that it's not documented. I can comment this out if you
// think it's a bad idea to show it here.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would go for commenting it out until we actually have it

Copy link
Contributor

@exekias exekias left a comment

Choose a reason for hiding this comment

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

Left a minor comment, OK to merge & backport as it is to get it before the release

@dedemorton dedemorton merged commit 478cee6 into elastic:master Nov 13, 2018
dedemorton added a commit to dedemorton/beats that referenced this pull request Nov 13, 2018
* Add initial skeleton for Beats Central Management docs

* Add security warning

* Add enrollment command details

* Edits and additions

* Add fixes from review plus xpack role tags
dedemorton added a commit that referenced this pull request Nov 13, 2018
* Add initial skeleton for Beats Central Management docs

* Add security warning

* Add enrollment command details

* Edits and additions

* Add fixes from review plus xpack role tags
dedemorton added a commit to dedemorton/beats that referenced this pull request Nov 13, 2018
* Add initial skeleton for Beats Central Management docs

* Add security warning

* Add enrollment command details

* Edits and additions

* Add fixes from review plus xpack role tags
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Nov 13, 2018
dedemorton added a commit that referenced this pull request Nov 13, 2018
* Add initial skeleton for Beats Central Management docs

* Add security warning

* Add enrollment command details

* Edits and additions

* Add fixes from review plus xpack role tags
@dedemorton dedemorton deleted the cm-docs branch November 13, 2018 18:23
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
…lastic#9060)

* Add initial skeleton for Beats Central Management docs

* Add security warning

* Add enrollment command details

* Edits and additions

* Add fixes from review plus xpack role tags
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.

2 participants