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 module docs #16571

Merged
merged 4 commits into from
Feb 26, 2020
Merged

[docs] Restructure module docs #16571

merged 4 commits into from
Feb 26, 2020

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Feb 25, 2020 •
edited
Loading

Fixes #16475

Summary of changes:

  • Remove commands for setting up and running module. Point users to quick start instead.
  • Move dashboard examples to the end of the topic to make config info more obvious.
  • Fix a few minor nits to make content more consistent.
  • Comment out a few compatibility sections because they were empty and would probably result in build errors.

I'll follow up with a separate PR if the module generator needs any updates.

@dedemorton dedemorton added docs in progress Pull request is currently in progress. Filebeat Filebeat labels Feb 25, 2020
@dedemorton dedemorton requested a review from a team as a code owner February 25, 2020 16:50
@dedemorton dedemorton requested a review from a team as a code owner February 25, 2020 20:28
@dedemorton dedemorton changed the title [WIP][docs] Restructure module docs [docs] Restructure module docs Feb 25, 2020
@dedemorton
Copy link
Contributor Author

dedemorton commented Feb 25, 2020 •
edited
Loading

@honzakral Here's the change you wanted. Docs still need some cleanup (as always), but hopefully this is a start.

@dedemorton dedemorton added review and removed in progress Pull request is currently in progress. labels Feb 25, 2020
@dedemorton dedemorton self-assigned this Feb 26, 2020
benskelker
benskelker approved these changes Feb 26, 2020
View reviewed changes
Copy link

@benskelker benskelker left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks

@dedemorton dedemorton merged commit 4381e9e into elastic:master Feb 26, 2020
@dedemorton dedemorton deleted the issue#16475 branch February 26, 2020 18:32
@dedemorton dedemorton added the needs_backport PR is waiting to be backported to other branches. label Feb 26, 2020
dedemorton added a commit to dedemorton/beats that referenced this pull request Feb 29, 2020
@dedemorton
[docs] Restructure module docs (elastic#16571)
e36a5d9
@dedemorton dedemorton mentioned this pull request Feb 29, 2020
Merged
dedemorton added a commit to dedemorton/beats that referenced this pull request Feb 29, 2020
@dedemorton
[docs] Restructure module docs (elastic#16571)
910ff61
@dedemorton dedemorton mentioned this pull request Feb 29, 2020
Merged
dedemorton added a commit that referenced this pull request Mar 2, 2020
@dedemorton
[7.x][docs] Backport: Restructure module docs (#16571) (#16713)
f258a05
dedemorton added a commit that referenced this pull request Mar 2, 2020
@dedemorton
[7.6][docs] Backport: Restructure module docs (#16571) (#16712)
e142cea
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benskelker benskelker benskelker approved these changes

@tsg tsg Awaiting requested review from tsg

Assignees

@dedemorton dedemorton

Labels
docs Filebeat Filebeat review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove setup and run steps from the docs for individual modules
2 participants
@dedemorton @benskelker