Review, edit, and publish ingest management docs

[dedemorton]

This is a meta issue for tracking:

• ingest management docs that require writer review or edit
• other writer tasks to support the documentation effort

Reviews required by writer:

• Review/edit "Basic Elastic Agent documentation" [Ingest Manager] Basic Elastic Agent documentation #19030
• Review/edit "Fleet configuration flags" [Ingest Manager] Document fleet configuration flags kibana#66736
• Review "Ingest Management Guide" Add Ingest Management Guide. stack-docs#1126
• Approve Ingest Manager topic [Ingest Manager] Clean up main doc directory kibana#68785
• Light review of Ingest management overview (will do full edit in a separate PR) Initial draft for ingest management overview stack-docs#1144
• Light review of troubleshooting topic Add Ingest Manager Troubleshooting FAQ doc stack-docs#1148

Writer PRs waiting for review:

• Ingest Manager edits [DOCS] Fix table formatting in ingest manager settings kibana#68824
• Add shared attributes Add an attribute for ingest management docs#1867
• Get ingest management docs ready for publishing Get ingest management docs ready to publish stack-docs#1147
• Get ingest management docs building Get Ingest Management docs building docs#1864
• Edit Elastic Agent docs Edit Elastic Agent docs #19146
• Edit Ingest Manager topic in Kibana [DOCS] Add ingest manager topic kibana#68980
• Edit troubleshooting topic Edit ingest management troubleshooting docs stack-docs#1160
• Get agent docs building Get agent docs building stack-docs#1163
• Edit the overview Edit ingest management overview stack-docs#1168
• Edit getting started guide Edit ingest management getting started guide stack-docs#1175
• Fix problems in ingest management docs found during testing [DOCS] Fix problems in ingest management docs found during testing stack-docs#1194
• Fix problems in Elastic Agent docs found during testing [DOCS] Fix problems in Elastic Agent docs found during doc testing #19252

Other tasks:

• Turn on attribute resolution for example described here: variables in shell formatting are not expanded stack-docs#1192
• Add x-pack role to all Elastic Agent docs.
• Global change: use "the Agent" (uppercase) instead of "the agent" (lowercase).
• Point to Ingest Management guide from https://www.elastic.co/guide/en/kibana/7.8/ingest-manager-settings-kb.html
• Fix typo in troubleshooting: https://github.com/elastic/beats/issuess
• Fix this (from Sonja): the Kibana server must be able to connect to http://epr-experimental.elastic.co on port 80. (in the troubleshooting section) should be https and port 443
• Fix issues identified by Jason:
  • Link the limitations of this release to the top of the getting started guide?
  • Move the fleet instructions above standalone on the getting started guide? I'd like to encourage people to use Fleet, and flows nicely from the section above on setting up integrations.
• Make sure content about Ingest Manager from closed PR is covered in the docs Ingest Manager intro #19136
• Edit troubleshooting topic
• Edit the overview and uncomment it.
• Edit Ingest Manager topic (added by [Ingest Manager] Clean up main doc directory kibana#68785) - rename file, get it hooked up to the navigation, etc
• Edit "Ingest Management Guide" (added by Add Ingest Management Guide. stack-docs#1126)
  • [x Fix linking in the Ingest Management Guide and make the task flow clearer.
• Hook up all ingest management topics and adjust the topic hierarchy, as required.
• Fix asciidoc coding in the Ingest Management Guide.
• Fix table formatting in [Ingest Manager] Document fleet configuration flags kibana#66736.
• Add ingest management docs to the doc build. (draft) Get Ingest Management docs building docs#1864
• Add shared attributes for ingest management. Add attributes for ingest management docs#1862
• Finalize terminology and possibly remove "Elastic Package Manager".
• Change heading levels to use level offsets (control the TOC hierarchy from the index file).
• Clean up all source files to use asiidoc attributes for product and feature names.

Testing

• Test all the procedures.
  • Getting started [DeDe][Brandon]
  • Beats agent docs [DeDe]
  • Troubleshooting
• Global checks and fixes:
  • Make sure xpack role is correctly assigned.
  • Make sure "experimental" label is applied
  • Clean up file structure:
    • Make sure every topic has an explicit anchor name and fix potential SEO issues with naming.
    • Make sure each HTML file maps to a single asciidoc source file and refactor, as needed.

Docs that are published and ready for alpha:

• Ingest management Guide:
  • Overview
  • Getting started with ingest management
  • Agent docs
  • Troubleshooting
• Kibana Guide:
  • Ingest Manager settings
  • Ingest Manager stub

Remaining work (after 7.8 docs are merged):

• In getting started, reword the steps that tells users that the required settings are enabled. Change misleading sentence about required config settings stack-docs#1197
• Update the discuss forum link to: https://discuss.elastic.co/tags/c/elastic-stack/81/stack-ingest-management
• Add widget code and single source commands. Opened draft PR, but we won't merge until we get the final design for the widgets in place.
• Remove reviewer notes and cleanup todo comments.
• Remove release state overrides.
• Document configuration setting details or provide full example file (currently commented out because the info was outdated). We will add documentation about config settings in 7.9.
• Some flags are missing from the CLI docs. Is that intentional? (see https://github.com/elastic/observability-dev/issues/922#issuecomment-645469486). Yes. We will document remaining flags in 7.9.
• Open issue to edit Ingest Manager text strings.
• Figure out what to do with the dev docs under x-pack/plugins/ingest_manager/dev_docs/ in Kibana. Not sure whether they can stay there.
• Follow up on terminology decision to capitalize Agent when used alone. I think it's awkward and isn't consistent other guidelines. Created issue Fix typo in gettingstarted doc #176 in the style-guide repo.

Related meta issue:
https://github.com/elastic/integrations-dev/issues/11

[elasticmachine]

Pinging @elastic/ingest-management (Team:Ingest Management)

[dedemorton]

Closing this out for the alpha. I'll create issues to track any future cleanup work that we need to do in 7.9.