Skip to content

Add content to the Observability Guide#16

Merged
EamonnTP merged 12 commits intoelastic:masterfrom
EamonnTP:add-observability-docs
Aug 5, 2020
Merged

Add content to the Observability Guide#16
EamonnTP merged 12 commits intoelastic:masterfrom
EamonnTP:add-observability-docs

Conversation

@EamonnTP
Copy link
Copy Markdown
Contributor

@EamonnTP EamonnTP commented Jul 2, 2020

This PR adds content to the new Observability Guide:

  • What is Elastic Observability?
  • Getting started
  • Ingesting data
  • Observability overview page

HTML preview

https://observability-docs_16.docs-preview.app.elstc.co/guide/en/observability/master/index.html

Related PRs

elastic/beats#19947
elastic/docs#1901
elastic/apm-server#3976
elastic/apm-server#4006

Related issue

Closes https://github.com/elastic/observability-dev/issues/252

@EamonnTP EamonnTP added docs Improvements or additions to documentation v7.9.0 labels Jul 2, 2020
@bmorelli25 bmorelli25 added v7.9.0 v7.9.0 and removed v7.9.0 labels Jul 6, 2020
@EamonnTP
Copy link
Copy Markdown
Contributor Author

EamonnTP commented Jul 8, 2020

@elasticmachine, run elasticsearch-ci/docs

@EamonnTP
Copy link
Copy Markdown
Contributor Author

@elasticmachine, run elasticsearch-ci/docs

Copy link
Copy Markdown
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.

Good stuff! Here's my first round of feedback.

Copy link
Copy Markdown
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.

Something else I just noticed: We should probably match the file names to the id. Otherwise, we'd just have to rename these files later.

Copy link
Copy Markdown
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.

This is great! I read through everything and tested the log steps. I want to get these initial comments added so they don't sit for too long.

I still need to test the other steps and will be submitting any feedback tomorrow.

@bmorelli25
Copy link
Copy Markdown
Member

@elasticmachine, run elasticsearch-ci/docs

Copy link
Copy Markdown
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.

Looking better and better with every iteration!

Copy link
Copy Markdown
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.

These docs are going to make it a lot easier for users to get running without bouncing between multiple books! I went through and tested the content about logs, metrics, and uptime. I didn't test the APM steps, though.

Seeing how much content is taken directly from the Filebeat and Metricbeat quick starts, I'm worried the docs are going to get out of sync. We'll need to have to plan to keep the obs and Beats docs in sync, or bite the bullet and use shared regions. At any rate, looks like we're off to a good start!

@EamonnTP
Copy link
Copy Markdown
Contributor Author

We'll need to have to plan to keep the obs and Beats docs in sync, or bite the bullet and use shared regions. At any rate, looks like we're off to a good start!

@dedemorton I'll add this to our agenda for an Obs sync discussion

@elastic elastic deleted a comment Jul 22, 2020
@bmorelli25
Copy link
Copy Markdown
Member

What about something like this to replace the main image? I'm not a designer, so I'm more than open to any criticism or feedback.
Obs docs@2x (3)

@ghost
Copy link
Copy Markdown

ghost commented Jul 23, 2020

A docs preview will be available soon:
- HTML diff
- Observability guide

@EamonnTP
Copy link
Copy Markdown
Contributor Author

@bmorelli25 @dedemorton I updated the content on the Observability introduction page. When you have time, could you give it a review? Thanks.

@andresrc
Copy link
Copy Markdown
Contributor

pinging for review: @elastic/observability

Copy link
Copy Markdown

@masci masci left a comment

Choose a reason for hiding this comment

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

Good stuff! Left some feedback, hope it makes sense :)

Copy link
Copy Markdown
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.

LGTM

@EamonnTP EamonnTP merged commit a54c7ea into elastic:master Aug 5, 2020
@EamonnTP EamonnTP changed the title [WIP] Add content to the Observability Guide Add content to the Observability Guide Aug 5, 2020
EamonnTP pushed a commit to EamonnTP/observability-docs that referenced this pull request Aug 5, 2020
* add draft content

* Add widgets and update images

* add beats root attribute

* Fix broken links

* Add tab widgets

* Minor edits

* Updates following reviews

* Additional updates

* Update image

* Update landing page content

* Updates after review

* Remove attributes
EamonnTP pushed a commit to EamonnTP/observability-docs that referenced this pull request Aug 5, 2020
* add draft content

* Add widgets and update images

* add beats root attribute

* Fix broken links

* Add tab widgets

* Minor edits

* Updates following reviews

* Additional updates

* Update image

* Update landing page content

* Updates after review

* Remove attributes
EamonnTP pushed a commit that referenced this pull request Aug 5, 2020
* add draft content

* Add widgets and update images

* add beats root attribute

* Fix broken links

* Add tab widgets

* Minor edits

* Updates following reviews

* Additional updates

* Update image

* Update landing page content

* Updates after review

* Remove attributes
EamonnTP pushed a commit that referenced this pull request Aug 5, 2020
* add draft content

* Add widgets and update images

* add beats root attribute

* Fix broken links

* Add tab widgets

* Minor edits

* Updates following reviews

* Additional updates

* Update image

* Update landing page content

* Updates after review

* Remove attributes
@EamonnTP EamonnTP deleted the add-observability-docs branch August 5, 2020 09:09
dedemorton pushed a commit to dedemorton/observability-docs that referenced this pull request Mar 15, 2022
colleenmcginnis added a commit to colleenmcginnis/observability-docs that referenced this pull request May 22, 2024
* new links to apm docs yay

* do not copy content from enObservabilityIngestTraces to serverlessObservabilityApmGetStarted

* testing testing 123

* test with a serverless page that has multiple classic sources

* Revert "testing testing 123"

This reverts commit bca9ff98059e73651a5bed2935e11060662745ae.

* Revert "test with a serverless page that has multiple classic sources"

This reverts commit 6af87d486620c7109a23f621871aa0d8dd6681b0.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation v7.9.0 v7.9.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants