Skip to content

docs: say that login is for remote Akka Platform environments and link to the login page - #2061

Merged
ennru merged 1 commit into
mainfrom
docs/login-scope-sweep
Oct 13, 2026
Merged

ennru merged 1 commit into
mainfrom
docs/login-scope-sweep

Conversation

@TylerJewell

@TylerJewell TylerJewell commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Depends on #2060. That PR must be merged first. This PR's base is the docs/cli-conventions branch from #2060, so the diff shows only the change in this PR. #2058 and #2059 have merged. When #2060 merges, change the base to main. Next in the stack: #2064.

What changes

Pages that tell the reader to log in now link to the "Login to a remote env" page from #2059, and the CLI reference index states when login applies: only to deploy to or manage a remote Akka Platform environment, at akka.io or installed in an enterprise.

Page Change
Deploy to akka.io, step 2 "Authenticate the CLI with your Akka account" becomes "Log in to Akka".
Shopping cart deploy, step 2 Same change.
Inference > Serving your first model, prerequisites "installed and logged in" becomes "installed and logged in to a remote Akka environment", linking to both the install and login pages.
Operating > Container registries The "logged into Akka" prerequisite links to the login page.
Operating > Create a project "log into your account" links to the login page.
Operating > Platform API "logged in" links to the login page.
Developing > Running locally "logged in" links to the login page.
Reference > CLI command reference, "Log in to Akka" Adds the sentence stating when login applies. Edited in both index.adoc and cli-index-header.template.txt, because the index is generated from the template.

Text and links only. Nothing is moved or removed.

Test

  • Local Antora build: no errors or warnings on any changed page. The links to the login page resolve.
  • Vale run locally on the changed files: 0 errors, 0 warnings.

@TylerJewell

Copy link
Copy Markdown
Contributor Author

Merge order: #2060 must be merged before this PR, then #2059, then #2058. This PR's base is the #2060 branch.

@TylerJewell

Copy link
Copy Markdown
Contributor Author

Next in the stack: #2064 (CLI reference restructure and Operating trim). Merge this PR first.

@ennru
ennru force-pushed the docs/cli-conventions branch from fbd9e24 to 56bf594 Compare October 13, 2026 17:01
@TylerJewell
TylerJewell force-pushed the docs/login-scope-sweep branch 2 times, most recently from bf9f0e2 to 4a31445 Compare October 13, 2026 17:04
@TylerJewell

Copy link
Copy Markdown
Contributor Author

Update: #2058 and #2059 have merged, and this branch is restacked so it contains only its own commit. Merge order is now #2060, then this PR, then #2064.

Base automatically changed from docs/cli-conventions to main October 13, 2026 17:09
…k to the login page

Pages that tell the reader to log in now link to the login page, and the CLI reference index states when login applies.
@ennru
ennru force-pushed the docs/login-scope-sweep branch from 4a31445 to 07e5e10 Compare October 13, 2026 17:13
@ennru
ennru merged commit 0c5c091 into main Oct 13, 2026
11 checks passed
@ennru
ennru deleted the docs/login-scope-sweep branch October 13, 2026 17:16
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