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 PR 4488 to Serverless - adding k8s-otel quickstart guide #4589

Merged
merged 8 commits into from
Nov 29, 2024

Conversation

eedugon
Copy link
Contributor

@eedugon eedugon commented Nov 27, 2024

Description

Porting #4488 to Serveless
Added a fix in stateful get-started main doc on the quickstarts section (missing links to the recently created quickstart guides).

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 #4535

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>

@eedugon eedugon requested a review from a team as a code owner November 27, 2024 14:11
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.

Copy link
Contributor

mergify bot commented Nov 27, 2024

This pull request does not have a backport label. Could you fix it @eedugon? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Nov 27, 2024
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 a couple minor edits to make this consistent with #4582.

Also make sure that you update the getting started overview here to include the link to the new quickstart: https://observability-docs_bk_4582.docs-preview.app.elstc.co/guide/en/observability/master/observability-get-started.html#quickstarts-overview

docs/en/serverless/quickstarts/monitor-k8s-otel.asciidoc Outdated Show resolved Hide resolved
docs/en/serverless/quickstarts/monitor-k8s-otel.asciidoc Outdated Show resolved Hide resolved
@eedugon
Copy link
Contributor Author

eedugon commented Nov 28, 2024

Also make sure that you update the getting started overview here to include the link to the new quickstart:

Good catch @dedemorton , I had forgotten it even for the stateful docs, and I've seen that @alaudazzi had also forgotten it when adding the firehose quickstart in stateful. So I've updated the file observability-get-started.asciidoc in both doc sets (serverless and stateful).

@eedugon
Copy link
Contributor Author

eedugon commented Nov 28, 2024

As now this PR touches a stateful file I'm adding backport labels.
cc: @dedemorton and @alaudazzi

@eedugon eedugon 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 and removed backport-skip Skip notification from the automated backport with mergify labels Nov 28, 2024
@alaudazzi
Copy link
Contributor

Have we agreed to remove the images in the Collect your data section?

@eedugon
Copy link
Contributor Author

eedugon commented Nov 28, 2024

@alaudazzi ,

Have we agreed to remove the images in the Collect your data section?

No, we haven't, we've decided to keep them as we can always remove them instead of updating if they end up being outdated too fast.

Take a look at @dedemorton's comment #4582 (comment)

Also PR 4582 is already merged and the updated screenshot in firehose quickstart is live :)

alaudazzi
alaudazzi previously approved these changes Nov 28, 2024
Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

I left a few minor editing suggestions, otherwise LGTM.

docs/en/serverless/quickstarts/monitor-k8s-otel.asciidoc Outdated Show resolved Hide resolved
docs/en/serverless/quickstarts/monitor-k8s-otel.asciidoc Outdated Show resolved Hide resolved
@eedugon eedugon requested a review from dedemorton November 28, 2024 14:15
@eedugon
Copy link
Contributor Author

eedugon commented Nov 28, 2024

This requires a final review as after changing a new file the merge is not possible (cc: @dedemorton ) :)

@eedugon eedugon merged commit 58c98f8 into elastic:main Nov 29, 2024
5 checks passed
@eedugon eedugon deleted the PR_4488_serverless branch November 29, 2024 06:56
mergify bot pushed a commit that referenced this pull request Nov 29, 2024
* k8s-otel quickstart added to serverless
* minor fixes in stateful

(cherry picked from commit 58c98f8)

# Conflicts:
#	docs/en/serverless/index.asciidoc
#	docs/en/serverless/observability-get-started.asciidoc
mergify bot pushed a commit that referenced this pull request Nov 29, 2024
* k8s-otel quickstart added to serverless
* minor fixes in stateful

(cherry picked from commit 58c98f8)

# Conflicts:
#	docs/en/serverless/index.asciidoc
#	docs/en/serverless/observability-get-started.asciidoc
mergify bot pushed a commit that referenced this pull request Nov 29, 2024
* k8s-otel quickstart added to serverless
* minor fixes in stateful

(cherry picked from commit 58c98f8)

# Conflicts:
#	docs/en/serverless/index.asciidoc
#	docs/en/serverless/observability-get-started.asciidoc
eedugon added a commit that referenced this pull request Dec 2, 2024
…uickstart guide (#4607)

* Port PR 4488 to Serverless - adding k8s-otel quickstart guide (#4589)

* k8s-otel quickstart added to serverless
* minor fixes in stateful

(cherry picked from commit 58c98f8)

# Conflicts:
#	docs/en/serverless/index.asciidoc
#	docs/en/serverless/observability-get-started.asciidoc

* Delete docs/en/serverless directory

---------

Co-authored-by: Edu González de la Herrán <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
eedugon added a commit that referenced this pull request Dec 2, 2024
…uickstart guide (#4606)

* Port PR 4488 to Serverless - adding k8s-otel quickstart guide (#4589)

* k8s-otel quickstart added to serverless
* minor fixes in stateful

(cherry picked from commit 58c98f8)

# Conflicts:
#	docs/en/serverless/index.asciidoc
#	docs/en/serverless/observability-get-started.asciidoc

* Delete docs/en/serverless directory

---------

Co-authored-by: Edu González de la Herrán <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
eedugon added a commit that referenced this pull request Dec 2, 2024
…ickstart guide (#4605)

* Port PR 4488 to Serverless - adding k8s-otel quickstart guide (#4589)

* k8s-otel quickstart added to serverless
* minor fixes in stateful

(cherry picked from commit 58c98f8)

# Conflicts:
#	docs/en/serverless/index.asciidoc
#	docs/en/serverless/observability-get-started.asciidoc

* Delete docs/en/serverless directory

---------

Co-authored-by: Edu González de la Herrán <[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.

Port PR #4488 to Serverless
3 participants