Skip to content

docs: retire Using the Akka CLI so each of its tasks has one home in Operating - #2072

Merged
ennru merged 1 commit into
mainfrom
docs/operating-cli-overlap
Oct 14, 2026
Merged

ennru merged 1 commit into
mainfrom
docs/operating-cli-overlap

Conversation

@TylerJewell

Copy link
Copy Markdown
Contributor

The Operating section still had a Using the Akka CLI page. It repeated what Getting started and the CLI command map now cover, and documented two commands incorrectly.

Where its tasks now live:

  • Listing projects: Create a new project, under "List your projects".
  • Service status and details: Deploy and manage services. akka services get joins the status section, which links to Viewing data for listing components.
  • Following logs: View logs, with akka logs --follow --tail. The old page used akka services logs, which has no page in the CLI reference.
  • Everything else: the old page only linked out, so nothing else needed a new home.

The old page also showed akka services components my-service list, with the arguments in the wrong order; that form prints help and lists nothing. Viewing data already has the correct form.

The old URLs (operations/cli/using-cli.html and reference/cli/using-cli.html) redirect to the CLI command map, which answers the same question: which command does a task.

Checked: Vale is clean on the changed pages, and a local Antora build shows no errors in the changed pages.

🤖 Generated with Claude Code

…Operating

The page repeated install, login, and command lookup that Getting started and
the CLI command map now cover. Its old URLs redirect to the command map.
@github-actions github-actions Bot added the documentation documentation related label Oct 14, 2026
@ennru
ennru merged commit b2e8a09 into main Oct 14, 2026
11 checks passed
@ennru
ennru deleted the docs/operating-cli-overlap branch October 14, 2026 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants