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

[APM] Add Table of contents to data model docs #114608

Merged
merged 2 commits into from
Oct 12, 2021
Merged

[APM] Add Table of contents to data model docs #114608

merged 2 commits into from
Oct 12, 2021

Conversation

sorenlouv
Copy link
Member

Adds a a TOC to the data model docs

@sorenlouv sorenlouv requested a review from a team as a code owner October 12, 2021 10:09
@botelastic botelastic bot added the Team:APM All issues that need APM UI Team support label Oct 12, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:apm)

@sorenlouv sorenlouv added auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v7.16.0 labels Oct 12, 2021
@sorenlouv sorenlouv enabled auto-merge (squash) October 12, 2021 10:48
gbamparop
gbamparop approved these changes Oct 12, 2021
View reviewed changes
x-pack/plugins/apm/dev_docs/apm_queries.md
@@ -1,7 +1,17 @@
# Data model
### Table of Contents
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice one, I think the table of contents is helpful as the doc has started to grow

@sorenlouv sorenlouv merged commit 4f89393 into master Oct 12, 2021
@sorenlouv sorenlouv deleted the apm-toc-data-model-docs branch October 12, 2021 13:40
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 12, 2021
@sorenlouv @kibanamachine
[APM] Add Table of contents to data model docs (elastic#114608)
815104f
@kibanamachine kibanamachine mentioned this pull request Oct 12, 2021
Merged
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
✅ 7.x

This backport PR will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Oct 12, 2021
@kibanamachine @sorenlouv
[APM] Add Table of contents to data model docs (#114608) (#114632)
e9f058c 
Co-authored-by: Søren Louv-Jansen <[email protected]>
smith
smith reviewed Oct 12, 2021
View reviewed changes
Copy link
Contributor

@smith smith left a comment

Choose a reason for hiding this comment

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

GitHub automatically generates a toc and you can navigate it using this icon:

CleanShot 2021-10-12 at 13 25 33@2x

Seems like this gives the writer an extra maintenance task that GitHub is already doing for us.

@sorenlouv
Copy link
Member Author

Ah, that's cool. I was not aware of that feature. If I'm in the minority and most people know about this feature I can see how it's just redundant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@smith smith smith left review comments

@gbamparop gbamparop gbamparop approved these changes

Assignees
No one assigned
Labels
auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support v7.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@sorenlouv @elasticmachine @kibanamachine @smith @gbamparop