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

Port #4341 to stateful docs: Add new page on inventory #4438

Merged
merged 3 commits into from
Oct 31, 2024

Conversation

alaudazzi
Copy link
Contributor

Description

This PR adds a new page on Inventory (port #4341 to stateful docs).

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4348

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

None apply, as this PR ports content from serverless to stateful.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

@alaudazzi alaudazzi added needs-writer-review backport-8.16 Automated backport with mergify labels Oct 27, 2024
@alaudazzi alaudazzi self-assigned this Oct 27, 2024
@alaudazzi alaudazzi requested a review from a team as a code owner October 27, 2024 11:32
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@alaudazzi
Copy link
Contributor Author

alaudazzi commented Oct 27, 2024

In the new Observability doc structure for 8.16, I've added the new Inventory page here:
image
@roshan-elastic If you have other preferences, please let me know.

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.

Just some minor things, otherwise LGTM. Thanks!

@alaudazzi
Copy link
Contributor Author

alaudazzi commented Oct 29, 2024

@dedemorton
The screenshots seem to be OK (at least from the local preview).
One question: I'm a bit confused about how the index is generated for the APM section. I thought I added the new Inventory page as described here, on the apm-view-and-analyze-data page:

include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/ui-overview/index.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/inventory.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/drill-down/index.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/filter-and-search/index.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/interpret/index.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/machine-learning.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/agent-explorer.asciidoc[leveloffset=+1]
include::{observability-docs-root}/docs/en/observability/apm/view-and-analyze/settings.asciidoc[leveloffset=+1]

but this is not appearing in the TOC
image

@dedemorton
Copy link
Contributor

dedemorton commented Oct 29, 2024

but this is not appearing in the TOC

Edit: The problem is that you are looking at the wrong branch. Try navigating to the preview through the diff link so that you don't accidentally get dumped into the wrong branch from the landing page.

Maybe it's a caching issues? Or maybe you got into the wrong branch by mistake and aren't looking at the preview? I can see the TOC entry here:

https://observability-docs_bk_4438.docs-preview.app.elstc.co/guide/en/observability/master/inventory.html

@dedemorton
Copy link
Contributor

dedemorton commented Oct 29, 2024

The screenshots seem to be OK (at least from the local preview).

I'm looking at your screenshots in the PR and they don't match what I see in the new navigation for 8.16 (see below). I'm looking at the latest snapshot build. But regardless, we should avoid including navigation in screen captures because it'll differ in 8.16 depending on whether users are looking at the new solution-based navigation or the "classic" navigation. The easy fix here is to just crop the page so that you don't show the navigation pane in the screenshot.

image

@dedemorton dedemorton added the backport-8.x Automated backport to the 8.x branch with mergify label Oct 29, 2024
@alaudazzi
Copy link
Contributor Author

@dedemorton
Images are now cropped and no longer display the nav pane. It would be great if you could have a final look and approve! Thanks for your thorough review!

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.

LGTM!

@alaudazzi alaudazzi merged commit c54a48d into elastic:main Oct 31, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Oct 31, 2024
* Add new page on inventory

* Update docs/en/observability/apm/view-and-analyze/inventory.asciidoc

Co-authored-by: DeDe Morton <[email protected]>

* Crop images to remove nav pane

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit c54a48d)
mergify bot pushed a commit that referenced this pull request Oct 31, 2024
* Add new page on inventory

* Update docs/en/observability/apm/view-and-analyze/inventory.asciidoc

Co-authored-by: DeDe Morton <[email protected]>

* Crop images to remove nav pane

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit c54a48d)
alaudazzi added a commit that referenced this pull request Oct 31, 2024
* Add new page on inventory

* Update docs/en/observability/apm/view-and-analyze/inventory.asciidoc

Co-authored-by: DeDe Morton <[email protected]>

* Crop images to remove nav pane

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit c54a48d)

Co-authored-by: Arianna Laudazzi <[email protected]>
alaudazzi added a commit that referenced this pull request Oct 31, 2024
* Add new page on inventory

* Update docs/en/observability/apm/view-and-analyze/inventory.asciidoc

Co-authored-by: DeDe Morton <[email protected]>

* Crop images to remove nav pane

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit c54a48d)

Co-authored-by: Arianna Laudazzi <[email protected]>
eedugon pushed a commit to eedugon/observability-docs that referenced this pull request Nov 6, 2024
…c#4438)

* Add new page on inventory

* Update docs/en/observability/apm/view-and-analyze/inventory.asciidoc

Co-authored-by: DeDe Morton <[email protected]>

* Crop images to remove nav pane

---------

Co-authored-by: DeDe Morton <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify Docset:Stateful needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Inventory] Port #4341 to stateful docs
2 participants