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.

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

APM: Put the "reference" back into reference docs #43

Closed
5 of 6 tasks
bmorelli25 opened this issue Mar 10, 2020 · 1 comment
Closed
5 of 6 tasks

APM: Put the "reference" back into reference docs #43

bmorelli25 opened this issue Mar 10, 2020 · 1 comment
Assignees

Comments

@bmorelli25
Copy link
Member

As a prerequisite to the Observability documentation overhaul, we should begin to:

  • Separate non-reference content from reference content
  • Improve TOC headings to be easier to scan
  • Sort lists in a consistent manner (alphabetically)

Beats prereqs

APM Server work

  • Break configuration section into two different sections: Configuration & How to
  • Sort lists alphabetically where feasible
  • manage storage section is still a mix of reference/guide
  • Improve scanability of the TOC by adding shorter nav titles with title abbreviations to APM specific topics:
== Long descriptive page title for SEO
++++
<titleabbrev>Short TOC header</titleabbrev>
++++

Related Issues

@bmorelli25 bmorelli25 self-assigned this Mar 10, 2020
@bmorelli25 bmorelli25 transferred this issue from elastic/apm-server Jul 15, 2020
@bmorelli25 bmorelli25 changed the title [docs] Put the "reference" back into reference docs APM: Put the "reference" back into reference docs Jul 15, 2020
@bmorelli25
Copy link
Member Author

I moved this to obs-docs to track additional changes, but for the most part, this issue was completed in elastic/apm-server#3459 and elastic/beats#16825.

The more I think about it, I think it makes more sense to close this and track additional changes in https://github.com/elastic/observability-dev/issues/647.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant