Beats doc updates

[dedemorton]

This is a meta issue to track Beats documentation work for 5.0.0. This issue was created towards the end of the 5.0.0 release, so it doesn't include all the changes made to the doc during the alpha releases.

If you have trouble clicking an item in the checklist to mark it as complete, open this comment in edit mode and change the source to [x]. Seems to be a bug in ticking the check boxes in this issue.

5.0 GA:

• Resolve any doc issues flagged for 5.0.0-GA. Some of the open doc issues are duplicated in this list.
• [DeDe] Document how to configure ingest node to have GeoIP info. See Document how to configure ingest node to have geoip info #1671
• Update Developer Guide. See Update Developer Guide #1077
• Create migration guide for 2.x to 5.x. See Create Migration Guide for 2.x to 5.x #1488
• [DeDe ] Document load-balancing modes in Filebeat. See Document load-balancing modes in filebeat #1852
• [DeDe] Submit request to get redirects set up. See Get redirects set up for the following topics:  #2426
• [DeDe] Add doc example that shows how to configure the Kafka output. See Add doc example that shows how to conifigure the Kafka output #1339
• [DeDe] Update links to shield documentation for 5.0. See Update links to Shield documentation for 5.0 #1308
• Edit Breaking changes and Upgrading doc (see Breaking changes and Upgrading docs #2631)
• [DeDe] Required cleanup:
  • Remove any known issue notes that are specific to the alpha or beta releases.
  • Remove any coming, added, or deprecated tags that are relevant to alpha and beta only (keep deprecation tags that mark items deprecated between 2.4 and 5.0).
  • Clean up config sections that were added to support changes between alpha4 and alpha5.
• Make a doc page that explains all the Breaking Changes
• Add label to indicate that doc about adding a new protocol is out-of date. Include a link to the protocol analyzer generator.
• [DeDe] Improve diagrams:
  • Improve conceptual diagram of Filebeat (see Improve conceptual diagram of Filebeat  #713).
  • Improve diagram in the overview to the Platform Reference (use new icons and logos).
  • Add diagram to metricbeat docs under "How Metricbeat Works" to show a couple of modules and metricsets within those modules
• Clarify docs about supported Filepath glob patterns. See Filebeat - Document Filepath Glob Patterns #2108
• Document Filebeat Load Balancing. See Document load-balancing modes in filebeat #1852

5.0 Beta 1:

• Resolve any doc issues flagged for 5.0.0-beta 1. Some of the open doc issues are duplicated in this list.
• Lots of other work that DeDe completed before she created this meta issue. :-)
• [Tudor] Document new repositories (add info about yum/apt repos). See Document new repositories  #2467 (fixed in Updated docs with new repositories #2617)
• [Tudor/DeDe] Document output supported versions. See Document supported versions #1450
• [Steffen] Update docs for index changes (add index pattern, rename index options). See Add index pattern, rename index options #2074
• [DeDe] Update screen captures.
• [DeDe] Misc content changes:
  • Remove restriction about intermediate CAs from the doc?
  • Clarify description of paths option. See Clarify description of paths option so users know its a filename pattern  #2193
  • Document why field names under event_data might be unnamed. See document why field names under event_data may be unnamed (named param1, param2, etc) #2192
  • Explain difference between short and long config files. See Explain difference between short and long config files #1844
  • Clearly document for Kibana users that a fresh index is required after loading custom structured logs.
  • Document -E flag?
• [DeDe] Misc editorial changes:
  • Add content about loading each dashboard to the docs for each beat. See Content about loading beats dashboards should be in the guide for each beat #1943
  • Remove comments from example configs in ref guides See Remove comments from example configs in the Beats reference guides #1795
  • Make sure container topics contain sufficient content. See Make sure all container topics contain sufficient content #1793
  • Use proper experimental flag here: https://www.elastic.co/guide/en/beats/filebeat/master/configuration-filebeat-options.html#_harvester_limit
  • Fix link text here to match heading: https://www.elastic.co/guide/en/beats/libbeat/master/event-conventions.html
• [DeDe] New or changed doc that requires an edit:
  • How filebeat works content (includes some topics that got into the troubleshooting section)
  • close_file options
  • Importing dashboards
  • Filebeat config options
  • Parsing and normalizing fields
  • Running Metricbeat in a container
• [DeDe] Required cleanup:
  • Remove alpha-specific notes about restrictions and changes.
  • When ES branches to 5.0, need to change variable to point to the doc-branch rather than hard-coding it as master. Basically need to reverse this: a356005

[dedemorton]

Moved remaining issues and wish list to #3019 to track them for 5.1.0.