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

Add deprecation warning to Jaeger API docs #4761

Merged
merged 4 commits into from
Jan 15, 2025

Conversation

rubvs
Copy link
Contributor

@rubvs rubvs commented Jan 10, 2025

Description

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 elastic/apm-server#14767

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>

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 Jan 10, 2025

This pull request does not have a backport label. Could you fix it @rubvs? 🙏
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 Jan 10, 2025
@rubvs rubvs force-pushed the api-jaeger-deprecation-notice branch from aa635d4 to ce3131d Compare January 15, 2025 14:34
@rubvs rubvs requested a review from simitt January 15, 2025 15:08
@rubvs rubvs marked this pull request as ready for review January 15, 2025 15:09
@rubvs rubvs requested a review from a team as a code owner January 15, 2025 15:09
Copy link
Contributor

@simitt simitt left a comment

Choose a reason for hiding this comment

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

minor nit, otherwise LGTM

@bmorelli25
Copy link
Member

I'm going to merge. I'm assuming this is only for 9.0. If that's not the case, let me know so I can add the right backport labels. Thanks!

@bmorelli25 bmorelli25 merged commit b8f4f23 into main Jan 15, 2025
3 checks passed
@bmorelli25 bmorelli25 deleted the api-jaeger-deprecation-notice branch January 15, 2025 23:48
@simitt
Copy link
Contributor

simitt commented Jan 16, 2025

@bmorelli25 this should actually go into docs >= 8.16 as the API has been deprecated with https://github.com/elastic/apm-server/pull/13809/files. While mentioned in the release notes, the docs weren't aligned with the change.

@colleenmcginnis colleenmcginnis 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 Jan 16, 2025
mergify bot pushed a commit that referenced this pull request Jan 16, 2025
* add deprecation warning to Jaeger API docs

* leverage warning header in asciidoc

* update pull request link

* minor lang correction

(cherry picked from commit b8f4f23)
mergify bot pushed a commit that referenced this pull request Jan 16, 2025
* add deprecation warning to Jaeger API docs

* leverage warning header in asciidoc

* update pull request link

* minor lang correction

(cherry picked from commit b8f4f23)
mergify bot pushed a commit that referenced this pull request Jan 16, 2025
* add deprecation warning to Jaeger API docs

* leverage warning header in asciidoc

* update pull request link

* minor lang correction

(cherry picked from commit b8f4f23)
bmorelli25 pushed a commit that referenced this pull request Jan 16, 2025
* add deprecation warning to Jaeger API docs

* leverage warning header in asciidoc

* update pull request link

* minor lang correction

(cherry picked from commit b8f4f23)

Co-authored-by: Ruben van Staden <[email protected]>
bmorelli25 pushed a commit that referenced this pull request Jan 16, 2025
* add deprecation warning to Jaeger API docs

* leverage warning header in asciidoc

* update pull request link

* minor lang correction

(cherry picked from commit b8f4f23)

Co-authored-by: Ruben van Staden <[email protected]>
bmorelli25 pushed a commit that referenced this pull request Jan 16, 2025
* add deprecation warning to Jaeger API docs

* leverage warning header in asciidoc

* update pull request link

* minor lang correction

(cherry picked from commit b8f4f23)

Co-authored-by: Ruben van Staden <[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 backport-8.17 Automated backport with mergify backport-skip Skip notification from the automated backport with mergify needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add note to docs that Jaeger protocol was deprecated
4 participants