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

Update quick starts for 7.16 #1248

Merged
merged 4 commits into from
Nov 11, 2021
Merged

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Nov 8, 2021

Summary

This PR updates the traces quick start and logs/metrics/uptime quick start for 7.16. It also updates the includes so that the traces quick start guide can be reused in the APM Guide in the APM Server repo.

Related

For #1073
For #1231
elastic/docs PR: elastic/docs#2281
elastic/apm-server PR: elastic/apm-server#6554

@bmorelli25 bmorelli25 added v8.0.0 Team:Docs Label for the Observability docs team v7.16.0 labels Nov 8, 2021
@bmorelli25 bmorelli25 requested a review from a team November 8, 2021 23:25
@bmorelli25 bmorelli25 self-assigned this Nov 8, 2021
@@ -63,7 +63,7 @@ installation package.
--
// tag::install-elastic-agent[]

include::{tab-widgets}/download-widget.asciidoc[]
Copy link
Member Author

Choose a reason for hiding this comment

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

These {tab-widgets} attributes are nice, but they don't allow cross-doc includes (as far as I can tell)

@apmmachine
Copy link
Contributor

A documentation preview will be available soon:

Comment on lines +147 to +154
// this if directive includes the same file, but changes the file path based on where this guide is built
ifndef::apm-integration-docs[]
include::{apm-repo-dir}/legacy/tab-widgets/install-agents-widget.asciidoc[]
endif::[]

ifdef::apm-integration-docs[]
include::{docdir}/legacy/tab-widgets/install-agents-widget.asciidoc[]
endif::[]
Copy link
Member Author

Choose a reason for hiding this comment

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

This is a bit of a mess, but it's the only way I could include this file in both the Observability Guide and APM Guide. Without the if directive, the file would error in one of the books.

Comment on lines +8 to +9
// THIS CONTENT IS ALSO USED IN THE APM GUIDE
// tag::apm-quick-start[]
Copy link
Member Author

Choose a reason for hiding this comment

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

This tag allows the content to be reused in the APM Guide.

@bmorelli25 bmorelli25 merged commit 6034dcc into elastic:master Nov 11, 2021
@bmorelli25 bmorelli25 deleted the update-quick-starts branch November 11, 2021 20:07
bmorelli25 added a commit to bmorelli25/observability-docs that referenced this pull request Nov 11, 2021
* docs: new screenshots

* docs: update text

* docs: use aboslute file paths instead of attrs

* docs: remove extra include
bmorelli25 added a commit to bmorelli25/observability-docs that referenced this pull request Nov 11, 2021
* docs: new screenshots

* docs: update text

* docs: use aboslute file paths instead of attrs

* docs: remove extra include
bmorelli25 added a commit that referenced this pull request Nov 11, 2021
* docs: new screenshots

* docs: update text

* docs: use aboslute file paths instead of attrs

* docs: remove extra include
bmorelli25 added a commit that referenced this pull request Nov 11, 2021
* docs: new screenshots

* docs: update text

* docs: use aboslute file paths instead of attrs

* docs: remove extra include
bmorelli25 added a commit to bmorelli25/observability-docs that referenced this pull request Apr 11, 2023
* docs: new screenshots

* docs: update text

* docs: use aboslute file paths instead of attrs

* docs: remove extra include
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs Label for the Observability docs team v7.16.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants