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

[WIP] Add Observability docs #1877

Merged
merged 2 commits into from
Jul 1, 2020
Merged

Conversation

EamonnTP
Copy link

@EamonnTP EamonnTP commented Jun 25, 2020

This PR is to add the forthcoming Observability docs. The PR includes:

  • Observability docs added to config file
  • Doc build alias for Observability docs
  • Observability docs added to shared attributes file

Related Issue:

@EamonnTP EamonnTP added the content Content architecture, organization, and sharing, including between books label Jun 25, 2020
@EamonnTP EamonnTP changed the title Add Observability docs [WIP] Add Observability docs Jun 25, 2020
Copy link
Member

@gtback gtback left a comment

Choose a reason for hiding this comment

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

LGTM! I'd wait for Brandon or DeDe to weigh in too, though.

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

I'll need to take a look when you have everything in place, but looks like you're on the right track! Just one small comment.

conf.yaml Outdated
@@ -905,6 +905,25 @@ contents:

- title: "Observability: APM, Logs, Metrics, and Uptime"
sections:
- title: Observability
prefix: en/observability
current: *stackcurrent
Copy link
Contributor

Choose a reason for hiding this comment

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

Depending on when you merge this, you'll need to make sure there's a 7.8 branch if you use stackcurrent. Other option is to set this to master.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, we need master here

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

This PR is blocking elastic/stack-docs#1233. As discussed on Slack, @EamonnTP will update this PR to do the following:

  • Update conf.yaml to move the source of logs/metrics/observability/ingest to the observability-docs repo
  • Update doc_build_aliases.sh for logs/metrics/observability/ingest
  • Update shared/attribtues.asciidoc for logs/metrics/observability/ingest

@EamonnTP EamonnTP merged commit e8f1b64 into elastic:master Jul 1, 2020
@EamonnTP EamonnTP deleted the add-obs-attributes branch July 1, 2020 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Content architecture, organization, and sharing, including between books
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants