Skip to content

docs: link published management docs#2955

Draft
He-Pin wants to merge 1 commit into
apache:mainfrom
He-Pin:port-f3a1da2-management-doc-links
Draft

docs: link published management docs#2955
He-Pin wants to merge 1 commit into
apache:mainfrom
He-Pin:port-f3a1da2-management-doc-links

Conversation

@He-Pin
Copy link
Copy Markdown
Member

@He-Pin He-Pin commented May 9, 2026

No description provided.

@He-Pin He-Pin marked this pull request as ready for review May 9, 2026 15:56
@pjfanning
Copy link
Copy Markdown
Member

we have not released rolling updates

Copy link
Copy Markdown
Member

@pjfanning pjfanning left a comment

Choose a reason for hiding this comment

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

this is premature

@He-Pin He-Pin marked this pull request as draft May 9, 2026 16:18
Motivation:
Eligible upstream source commit akka/akka-core@f3a1da2, which is now Apache licensed, improved navigation from core documentation to Management documentation. The rolling updates page from that change has not been released for Pekko yet, so this port should only link published Management pages.

Modification:
Convert published Pekko Management documentation links to Paradox extrefs and fix directly related documentation typos.

Result:
Core documentation resolves checked extrefs for available Management pages without pointing readers at unreleased rolling update content.

Tests:
- sbt docs/paradox
- git diff --check

References:
Refs upstream source commit: akka/akka-core@f3a1da2

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@He-Pin He-Pin force-pushed the port-f3a1da2-management-doc-links branch from c9e834b to 3978829 Compare May 9, 2026 20:49
@He-Pin He-Pin changed the title docs: link management rolling update docs docs: link published management docs May 9, 2026
@He-Pin
Copy link
Copy Markdown
Member Author

He-Pin commented May 9, 2026

Thanks, addressed. I rebased the branch and removed the links to the unreleased Management rolling updates page, keeping only the extrefs for published Management documentation. I also reran sbt docs/paradox.

## Health check

An [Pekko Management compatible health check]($pekko.doc.dns$/docs/pekko-management/current/healthchecks.html) is included that returns healthy once the local shard region
An @extref:[Pekko Management compatible health check](pekko-management:healthchecks.html) is included that returns healthy once the local shard region
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
An @extref:[Pekko Management compatible health check](pekko-management:healthchecks.html) is included that returns healthy once the local shard region
A @extref:[Pekko Management compatible health check](pekko-management:healthchecks.html) is included that returns healthy once the local shard region

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants