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.

Sign up for GitHub

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

Jump to bottom

[docs] Restructure and refactor beats documentation #16825

Merged
merged 7 commits into from
Mar 11, 2020
Merged

[docs] Restructure and refactor beats documentation #16825

merged 7 commits into from
Mar 11, 2020

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Mar 5, 2020 •
edited
Loading

Breaks the configuration section down into two separate sections. Also adds abbreviated titles to make the TOC easier to scan.

To do:

  • Apply structural changes to all Beats books.
  • Make config section order. consistent across all the books
  • Make titles consistent (use configure instead of set up in config section).
  • Make sure functionbeat sections are correctly flagged as xpack.
  • Do diff across all books to verify that nothing was dropped.
  • Do final check on files for consistency, etc.
  • Hold on merging until Brandon M. approves.

Assuming the build succeeds, you can preview the new navigation structure here:

http://beats_16825.docs-preview.app.elstc.co/diff

@dedemorton dedemorton added docs in progress Pull request is currently in progress. needs_backport PR is waiting to be backported to other branches. Team:Integrations Label for the Integrations team agent labels Mar 5, 2020
@dedemorton dedemorton self-assigned this Mar 5, 2020
@dedemorton dedemorton mentioned this pull request Mar 5, 2020
Closed
@dedemorton
Copy link
Contributor Author

I've tried to arrange the configuration section in what I perceive to be "logical" order (putting the settings users are likely to want to know about or set up stuff early on).

@dedemorton
Copy link
Contributor Author

@benskelker @bmorelli25 Just a heads-up that I'm doing some restructuring of the config section of the Beats documentation. After I get the nav structure ironed out, I am going to do some file refactoring (will rename and move a bunch of stuff). I'll probably do that in a separate PR, though.

@dedemorton dedemorton marked this pull request as ready for review March 7, 2020 03:34
@dedemorton dedemorton requested a review from a team as a code owner March 7, 2020 03:34
@dedemorton dedemorton changed the title [docs] Restructure and refactor beats documentation [docs] [WIP] Restructure and refactor beats documentation Mar 7, 2020
@benskelker
Copy link

@dedemorton thanks for the heads up

bmorelli25
bmorelli25 reviewed Mar 9, 2020
View reviewed changes
Copy link
Member

@bmorelli25 bmorelli25 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Overall, I think these changes look great! Love the new layout, and love how easy it is to browse the TOC because of the new <titleabbrev> 🔥!! I've left a few comments and questions below. Although I've only tagged one example, most comments apply to all Beat books. A couple of the comments are specific to just one book.

auditbeat/docs/auditbeat-filtering.asciidoc Outdated Show resolved Hide resolved
heartbeat/docs/configuring-howto.asciidoc Outdated Show resolved Hide resolved
filebeat/docs/upgrading.asciidoc Outdated Show resolved Hide resolved
heartbeat/docs/configuring-howto.asciidoc Outdated Show resolved Hide resolved
auditbeat/docs/setting-up-running.asciidoc Show resolved Hide resolved
heartbeat/docs/getting-started.asciidoc Show resolved Hide resolved
auditbeat/docs/howto/howto.asciidoc Show resolved Hide resolved
auditbeat/docs/reload-configuration.asciidoc Outdated Show resolved Hide resolved
dedemorton and others added 2 commits March 9, 2020 16:56
@dedemorton
Add remaining fixes from first review
28e4694
@dedemorton @bmorelli25
Change heading to simpler text
5eeef86 
Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com>
bmorelli25
bmorelli25 approved these changes Mar 10, 2020
View reviewed changes
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

LGTM

@dedemorton dedemorton changed the title [docs] [WIP] Restructure and refactor beats documentation [docs] Restructure and refactor beats documentation Mar 10, 2020
@dedemorton dedemorton removed the in progress Pull request is currently in progress. label Mar 10, 2020
@dedemorton dedemorton merged commit 30e432e into elastic:master Mar 11, 2020
@dedemorton dedemorton deleted the add_nav_titles_config branch March 11, 2020 19:17
dedemorton added a commit to dedemorton/beats that referenced this pull request Mar 11, 2020
@dedemorton
[docs] Restructure and refactor beats documentation (elastic#16825)
c64c351
@dedemorton dedemorton mentioned this pull request Mar 11, 2020
Merged
dedemorton added a commit to dedemorton/beats that referenced this pull request Mar 11, 2020
@dedemorton
[docs] Restructure and refactor beats documentation (elastic#16825)
0635664
@dedemorton dedemorton mentioned this pull request Mar 11, 2020
Merged
dedemorton added a commit that referenced this pull request Mar 11, 2020
@dedemorton
[docs] Restructure and refactor beats documentation (#16825) (#16965)
c9efdf3
dedemorton added a commit that referenced this pull request Mar 12, 2020
@dedemorton
[docs] Restructure and refactor beats documentation (#16825) (#16966)
9735c6d
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Mar 20, 2020
@bmorelli25 bmorelli25 mentioned this pull request Jul 15, 2020
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmorelli25 bmorelli25 bmorelli25 approved these changes

Assignees

@dedemorton dedemorton

Labels
docs review Team:Integrations Label for the Integrations team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dedemorton @benskelker @bmorelli25