-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Restructure navigation to move config options up #1794
Conversation
I need to do more work here because the book parts for the module section of metricbeat cause the topics about security and exported fields to be nested below modules. I'll submit a fix soon, but don't merge until I've done that. |
476b1bc
to
6be52cd
Compare
@elastic/beats I've updated the doc builds (links above) to reflect the high-level structural changes. WDYT? |
+1 on the changes. |
6be52cd
to
07f84cc
Compare
This should be ready to review now. I've updated the files on Firebase to reflect the latest changes. |
Nice. Restructuring looks very good. The Command line options and packetbeat directory layout are under 'Getting Started'. Don't think that's a good place for them. I like the 'How Metricbeat works' section. Would be nice to have this kind of overview for all beats (maybe even with schematic overview). Maybe putting command line options and directory layout in this section would make sense? |
@urso I def like the idea of adding "how this works" sections to all of the Beats (especially for the ones where users keep asking us for more detail about how they work). Not sure about moving the CLI and directory layout stuff into that section, though. If we had a dedicated section about installation, it would make sense to have those topics there, but since the GS provides the installation info, I think those two topics logically belong there. And since they are at the end, I don't think they distract from the getting started experience. |
include::../../libbeat/docs/yaml.asciidoc[] | ||
|
||
include::../../libbeat/docs/regexp.asciidoc[] | ||
|
||
include::./filebeat-filtering.asciidoc[] | ||
|
||
include::./multiline.asciidoc[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not 100% sure about the ordering here, as somehow further up means more important. I see the logic that regexp sohuld be understood to use mutiline, but I think people will first look for multiline and then jump to regexp. Same for yaml?
LGTM. Only left some minor comments that could also be addressed / discussed later. For command line options. I think there are 2 parts here: The very common onces like |
07f84cc
to
0b3dc49
Compare
@elastic/beats I think/hope this is ready to merge now. I've updated the builds at the links above so you can see the changes. The latest round of changes includes:
I'm not going to mess with the CLI and directory structure topics at the moment because I have another issue open to track changes to the getting started. |
First pass at restructuring topics for issue #1791
To what the files will look like in the build, go here (content will be available until this PR is closed):
UPDATED: 06.21.16
https://packetbeatrestructure.firebaseapp.com
https://winlogbeatrestructure.firebaseapp.com
https://filebeatrestructure.firebaseapp.com
https://metricbeatreorg.firebaseapp.com/