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

[DOCS] Add Observability topic #73041

Merged
merged 7 commits into from
Aug 5, 2020
Merged

[DOCS] Add Observability topic #73041

merged 7 commits into from
Aug 5, 2020

Conversation

EamonnTP
Copy link

@EamonnTP EamonnTP commented Jul 23, 2020 •
edited
Loading

Summary

This PR adds the topic about Observability to the Kibana reference.

HTML Preview

https://kibana_73041.docs-preview.app.elstc.co/guide/en/kibana/master/observability.html

Related issue

Closes elastic/observability-docs#53

@EamonnTP EamonnTP added release_note:skip Skip the PR/issue when compiling release notes v7.9.0 docs labels Jul 23, 2020
dedemorton
dedemorton reviewed Jul 23, 2020
View reviewed changes
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.

Minor comment. Otherwise looks fine. @gchaps might want to review it when she gets back.

@EamonnTP EamonnTP requested a review from gchaps July 28, 2020 14:39
KOTungseth
KOTungseth approved these changes Jul 28, 2020
View reviewed changes
Copy link
Contributor

@KOTungseth KOTungseth left a comment

Choose a reason for hiding this comment

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

I've left a handful of comments/suggestions, but otherwise, LGTM.

docs/observability/index.asciidoc
== Get started

{kib} provides step-by-step instructions to help you add and configure your data
sources. The {observability-guide}/index.html[Observability Guide] is a good source for more detailed information
Copy link
Contributor

Choose a reason for hiding this comment

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

{observability-guide}/index.html[Observability Guide] isn't appearing as a link

Copy link
Author

Choose a reason for hiding this comment

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

@KOTungseth That's strange. It looks fine here in the preview: https://kibana_73041.docs-preview.app.elstc.co/guide/en/kibana/master/observability.html

docs/observability/index.asciidoc
* An alerts chart to keep you informed of any issues that you may need to resolve quickly.

[role="screenshot"]
image::observability/images/observability-overview.png[Observability Overview in {kib}]
Copy link
Contributor

Choose a reason for hiding this comment

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

Since the nav bar is under construction for the next few releases, could you remove it from the screenshot?

Copy link
Author

@EamonnTP EamonnTP Jul 28, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@KOTungseth Sorry, do you mean the nav bar at the top of the page?

@EamonnTP
Copy link
Author

@elasticmachine merge upstream

gchaps
gchaps reviewed Aug 3, 2020
View reviewed changes
Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

Our TOC keeps getting longer--and less manageable. What do you think about this hierarchy for the Observability docs?

Observability
  APM
  Logs
  Metrics
  Uptime

@EamonnTP
Copy link
Author

EamonnTP commented Aug 3, 2020

Our TOC keeps getting longer--and less manageable. What do you think about this hierarchy for the Observability docs?

Observability
  APM
  Logs
  Metrics
  Uptime

@gchaps I've no objections to this. However, the APM docs already have a depth of two levels of topics and this would add a third. @dedemorton Any objections to this?

@dedemorton
Copy link
Contributor

dedemorton commented Aug 3, 2020 •
edited
Loading

@EamonnTP As you point out, putting APM under Observability right now would be difficult because of nesting limitations (that would require quite a bit of refactoring). I wouldn't recommend tackling that now, especially with Brandon away. I'd wait until we've built out the content in the Observability Guide, then it'll be easier to nest the Observability content in Kibana.

@gchaps
Copy link
Contributor

gchaps commented Aug 4, 2020

@EamonnTP @dedemorton We are pushing out an improved version of the Kibana docs hierarchy next month. Let's continue this discussion and find the best way for the Observability docs to fit in this new structure.

@EamonnTP
Copy link
Author

EamonnTP commented Aug 4, 2020

@gchaps Sounds good. Brandon is out until the 18th, so let's pick it up when he returns.

@EamonnTP EamonnTP merged commit f97641c into elastic:master Aug 5, 2020
@EamonnTP EamonnTP deleted the add-observability-docs branch August 5, 2020 08:28
This was referenced Aug 5, 2020
Merged
Merged
EamonnTP pushed a commit to EamonnTP/kibana that referenced this pull request Aug 5, 2020
@elasticmachine
[DOCS] Add Observability topic (elastic#73041)
8b18fb2 
* Add observability content

* Remove xpack from file name

* Updates following review

* Review edits

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
EamonnTP pushed a commit that referenced this pull request Aug 5, 2020
@elasticmachine
[DOCS] Add Observability topic (#73041) (#74333)
60e6bf8 
* Add observability content

* Remove xpack from file name

* Updates following review

* Review edits

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
EamonnTP pushed a commit that referenced this pull request Aug 5, 2020
@elasticmachine
[DOCS] Add Observability topic (#73041) (#74334)
26197e2 
* Add observability content

* Remove xpack from file name

* Updates following review

* Review edits

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
gmmorris added a commit to gmmorris/kibana that referenced this pull request Aug 5, 2020
@gmmorris
Merge branch 'master' into task-manager/fix-flaky-test
5907ed1 
* master: (74 commits)
  [Discover] Inline noWhiteSpace function (elastic#74331)
  [DOCS] Add Observability topic (elastic#73041)
  skip flaky suite (elastic#74327)
  [Security Solution][Detections] Fixes Severity Override not matching for Elastic Endpoint Security rule (elastic#74317)
  [Security Solution][Exceptions] - Fixes exceptions builder nested deletion issue and adds unit tests (elastic#74250)
  Fixed Alert details does not update page title and breadcrumb (elastic#74214)
  [src/dev/build] build Kibana Platform bundles from source (elastic#73591)
  [Reporting] Shorten asset path to help CLI FS Watcher (elastic#74185)
  Fix TMS not loaded in legacy maps (elastic#73570)
  [Security Solution] styling for notes' panel (elastic#74274)
  [Security Solution][Tech Debt] cleans up ts-ignore issues and some smaller linter issues  (elastic#74268)
  Make the actions plugin support generics (elastic#71439)
  [Security Solution] Keep original note creator (elastic#74203)
  [CI] Fix xpack kibana build dir in xpack visual regression script
  [CI] Fix baseline_capture job by adding parallel process number back
  [Monitoring] Ensure setup mode works on cloud but only for alerts (elastic#73127)
  [Maps] Custom color ramps should show correctly on the map for mvt layers (elastic#74169)
  [kbn/optimizer] remove unused modules (elastic#74195)
  [CI] Add pipeline task queue framework and merge workers into one (elastic#71268)
  Using msearch for tree api endpoint (elastic#73813)
  ...
gmmorris added a commit to gmmorris/kibana that referenced this pull request Aug 5, 2020
@gmmorris
Merge branch 'master' into actions/webhook-remove-header
2b09920 
* master: (115 commits)
  [Logs UI] Correct trial period duration in anomaly splash screen (elastic#74249)
  [Discover] Inline noWhiteSpace function (elastic#74331)
  [DOCS] Add Observability topic (elastic#73041)
  skip flaky suite (elastic#74327)
  [Security Solution][Detections] Fixes Severity Override not matching for Elastic Endpoint Security rule (elastic#74317)
  [Security Solution][Exceptions] - Fixes exceptions builder nested deletion issue and adds unit tests (elastic#74250)
  Fixed Alert details does not update page title and breadcrumb (elastic#74214)
  [src/dev/build] build Kibana Platform bundles from source (elastic#73591)
  [Reporting] Shorten asset path to help CLI FS Watcher (elastic#74185)
  Fix TMS not loaded in legacy maps (elastic#73570)
  [Security Solution] styling for notes' panel (elastic#74274)
  [Security Solution][Tech Debt] cleans up ts-ignore issues and some smaller linter issues  (elastic#74268)
  Make the actions plugin support generics (elastic#71439)
  [Security Solution] Keep original note creator (elastic#74203)
  [CI] Fix xpack kibana build dir in xpack visual regression script
  [CI] Fix baseline_capture job by adding parallel process number back
  [Monitoring] Ensure setup mode works on cloud but only for alerts (elastic#73127)
  [Maps] Custom color ramps should show correctly on the map for mvt layers (elastic#74169)
  [kbn/optimizer] remove unused modules (elastic#74195)
  [CI] Add pipeline task queue framework and merge workers into one (elastic#71268)
  ...
gmmorris added a commit to gmmorris/kibana that referenced this pull request Aug 5, 2020
@gmmorris
Merge branch 'master' into alerting/refresh-on-deletion
2024d25 
* master: (154 commits)
  [ML] Fix initial plugin's bundle size (elastic#74047)
  [Ingest Manager] prevent crash on unhandled rejection from setupIngestManager (elastic#74300)
  [Logs UI] Correct trial period duration in anomaly splash screen (elastic#74249)
  [Discover] Inline noWhiteSpace function (elastic#74331)
  [DOCS] Add Observability topic (elastic#73041)
  skip flaky suite (elastic#74327)
  [Security Solution][Detections] Fixes Severity Override not matching for Elastic Endpoint Security rule (elastic#74317)
  [Security Solution][Exceptions] - Fixes exceptions builder nested deletion issue and adds unit tests (elastic#74250)
  Fixed Alert details does not update page title and breadcrumb (elastic#74214)
  [src/dev/build] build Kibana Platform bundles from source (elastic#73591)
  [Reporting] Shorten asset path to help CLI FS Watcher (elastic#74185)
  Fix TMS not loaded in legacy maps (elastic#73570)
  [Security Solution] styling for notes' panel (elastic#74274)
  [Security Solution][Tech Debt] cleans up ts-ignore issues and some smaller linter issues  (elastic#74268)
  Make the actions plugin support generics (elastic#71439)
  [Security Solution] Keep original note creator (elastic#74203)
  [CI] Fix xpack kibana build dir in xpack visual regression script
  [CI] Fix baseline_capture job by adding parallel process number back
  [Monitoring] Ensure setup mode works on cloud but only for alerts (elastic#73127)
  [Maps] Custom color ramps should show correctly on the map for mvt layers (elastic#74169)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dedemorton dedemorton dedemorton left review comments

@gchaps gchaps gchaps left review comments

@bmorelli25 bmorelli25 bmorelli25 approved these changes

@KOTungseth KOTungseth KOTungseth approved these changes

Assignees
No one assigned
Labels
docs release_note:skip Skip the PR/issue when compiling release notes v7.9.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Observability content to Kibana docs
6 participants
@EamonnTP @dedemorton @gchaps @bmorelli25 @KOTungseth @elasticmachine