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 quickstarts for 8.16 #4582

Merged
merged 2 commits into from
Nov 27, 2024
Merged

Update quickstarts for 8.16 #4582

merged 2 commits into from
Nov 27, 2024

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Nov 26, 2024

Description

Updates the Observability quickstarts for version 8.16.0:

  • Applies requested changes.
  • Adds a few consistency edits.
  • Updates screenshots to match 8.16.

Preview links

Please remember to also review the changed lines shown in the Files changed tab.

Stateful:

Serverless:

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 #4534, #4562, and #4563

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • 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>

@dedemorton dedemorton added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Nov 26, 2024
@dedemorton dedemorton self-assigned this Nov 26, 2024
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

@dedemorton @eedugon
Specifically to the section "Collect your data", I would remove the screenshot as it adds no added value to the short list of steps.
More in general, screenshots generate lots of maintenance, especially when documenting new features, as the UI is supposed to change frequently.

@eedugon
Copy link
Contributor

eedugon commented Nov 26, 2024

I like the screenshots for this type of docs, at least to get an overview of what you are going to see when you follow the doc, even if it could get a bit outdated at some point.

But whatever you prefer, I completely understand the negative aspects of using screenshots, and as @alaudazzi says, the Collect data specifically doesn't add much value besides helping the user to determine that they are in the right place.

In anyway I would suggest to double check with PMs before removing the screenshots. If everybody agrees I'm totally ok with removing them too.

If the conversation is around the format of the screenshots of the collect data section then I prefer screenshots that show a good portion of the screen, like the one included in https://www.elastic.co/guide/en/observability/current/monitor-k8s-otel-edot.html#_collect_your_data_3 more than the capture of a very small part of the screen that ends up quite big and zoomed in the doc, like https://www.elastic.co/guide/en/observability/current/collect-data-with-aws-firehose.html#_collect_your_data_4.

In the second case I'd try at least to ensure the image doesn't ends up being too big on the final doc.

@dedemorton
Copy link
Contributor Author

Thanks for you input. Since we're split in the middle, for the review, I think I will include the screenshot (using the version that provides context) and ask PMs to make a case for keeping it. If the onboarding experience is more stable because most of the quickstarts are GA, then maybe it won't change as much going forward.

akhileshpok
akhileshpok previously approved these changes Nov 27, 2024
Copy link

@akhileshpok akhileshpok left a comment

Choose a reason for hiding this comment

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

The doc covering the quickstart onboarding workflow for Firehose in serverless does not mention that this functionality is currently in Tech Preview.

thomheymann
thomheymann previously approved these changes Nov 27, 2024
@dedemorton
Copy link
Contributor Author

The doc covering the quickstart onboarding workflow for Firehose in serverless does not mention that this functionality is currently in Tech Preview.

Good catch! The preview tag must have gotten removed when we did a general cleanup of preview tags for GA. (In some cases, the tag was doing double duty.)

Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

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

🦭 👍

@dedemorton dedemorton merged commit 9afec56 into elastic:main Nov 27, 2024
4 checks passed
@dedemorton dedemorton deleted the issue#4563 branch November 27, 2024 19:44
mergify bot pushed a commit that referenced this pull request Nov 27, 2024
* Update quickstarts for 8.16

* Add preview tag to aws firehose quickstart

(cherry picked from commit 9afec56)

# Conflicts:
#	docs/en/serverless/images/quickstart-autodetection-command.png
#	docs/en/serverless/images/quickstart-aws-firehose-entry-point.png
#	docs/en/serverless/images/quickstart-k8s-entry-point.png
#	docs/en/serverless/quickstarts/collect-data-with-aws-firehose.asciidoc
#	docs/en/serverless/quickstarts/k8s-logs-metrics.asciidoc
#	docs/en/serverless/quickstarts/monitor-hosts-with-elastic-agent.asciidoc
mergify bot pushed a commit that referenced this pull request Nov 27, 2024
* Update quickstarts for 8.16

* Add preview tag to aws firehose quickstart

(cherry picked from commit 9afec56)

# Conflicts:
#	docs/en/serverless/images/quickstart-autodetection-command.png
#	docs/en/serverless/images/quickstart-aws-firehose-entry-point.png
#	docs/en/serverless/images/quickstart-k8s-entry-point.png
#	docs/en/serverless/quickstarts/collect-data-with-aws-firehose.asciidoc
#	docs/en/serverless/quickstarts/k8s-logs-metrics.asciidoc
#	docs/en/serverless/quickstarts/monitor-hosts-with-elastic-agent.asciidoc
mergify bot pushed a commit that referenced this pull request Nov 27, 2024
* Update quickstarts for 8.16

* Add preview tag to aws firehose quickstart

(cherry picked from commit 9afec56)

# Conflicts:
#	docs/en/serverless/images/quickstart-autodetection-command.png
#	docs/en/serverless/images/quickstart-aws-firehose-entry-point.png
#	docs/en/serverless/images/quickstart-k8s-entry-point.png
#	docs/en/serverless/quickstarts/collect-data-with-aws-firehose.asciidoc
#	docs/en/serverless/quickstarts/k8s-logs-metrics.asciidoc
#	docs/en/serverless/quickstarts/monitor-hosts-with-elastic-agent.asciidoc
dedemorton added a commit that referenced this pull request Nov 27, 2024
* Update quickstarts for 8.16 (#4582)

* Update quickstarts for 8.16

* Add preview tag to aws firehose quickstart

(cherry picked from commit 9afec56)

* Delete docs/en/serverless directory

---------

Co-authored-by: DeDe Morton <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
dedemorton added a commit that referenced this pull request Nov 27, 2024
* Update quickstarts for 8.16 (#4582)

* Update quickstarts for 8.16

* Add preview tag to aws firehose quickstart

(cherry picked from commit 9afec56)

* Delete docs/en/serverless directory

---------

Co-authored-by: DeDe Morton <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
dedemorton added a commit that referenced this pull request Nov 27, 2024
* Update quickstarts for 8.16 (#4582)

* Update quickstarts for 8.16

* Add preview tag to aws firehose quickstart

(cherry picked from commit 9afec56)

* Delete docs/en/serverless directory

---------

Co-authored-by: DeDe Morton <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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 backport-8.17 Automated backport with mergify needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request]: Include on-premises Elasticsearch cluster as an option in all quickstart guides
6 participants