docs: sort the top-level directories into five sections by what the reader wants
Every docs directory moves under 1-getting-started, 2-handbook, 4-implementation or 5-project; the options reference (section 3) comes from the website and has no directory here. trust-boundary stays whole under the handbook for now. web-ui, swarm and tools split between handbook and implementation, and the command-line references move to 2-handbook/reference. Links, path references in code and nix, and the docs index follow the moves; no page content changes.
This commit is contained in:
parent
53ccbcb4b3
commit
6739bb903d
1 changed files with 736 additions and 701 deletions
|
|
@ -7,9 +7,9 @@
|
|||
# The file backend is the right shape, not a placeholder for LDAP: what
|
||||
# makes a directory necessary is the size of the subject set, and this
|
||||
# one is bounded by a swarm. Who writes that store, and why it is a
|
||||
# program rather than a config file, is in `docs/swarm/sso.md`.
|
||||
# program rather than a config file, is in `docs/2-handbook/swarm/sso.md`.
|
||||
#
|
||||
# `docs/swarm/sso.md` owns the role model — session provider always, OIDC
|
||||
# `docs/2-handbook/swarm/sso.md` owns the role model — session provider always, OIDC
|
||||
# provider derived from the client list — and the secrets map.
|
||||
#
|
||||
# Per-service integration — the `auth_request` in front of a vhost —
|
||||
|
|
@ -34,8 +34,8 @@ let
|
|||
# `swarmctl user add --group <this>` is what grants it — the two must
|
||||
# agree, and one constant is how they stay agreeing.
|
||||
#
|
||||
# ⚠️ `admins` and not a new word, because `docs/getting-started/setup.md` and
|
||||
# `docs/swarm/sso.md` have been telling every operator to create
|
||||
# ⚠️ `admins` and not a new word, because `docs/1-getting-started/setup.md` and
|
||||
# `docs/2-handbook/swarm/sso.md` have been telling every operator to create
|
||||
# exactly that group since the bootstrap step existed. This is the
|
||||
# first rule that CONSUMES a group name; picking a different one would
|
||||
# have meant every account created by following the guide silently
|
||||
|
|
@ -281,7 +281,7 @@ let
|
|||
# One machine client per hive in the roster. The model — why identity is
|
||||
# per hive rather than per service, why `audience` is the client id, and
|
||||
# why these tokens are signed rather than opaque — is in
|
||||
# `docs/swarm/sso.md`, § Machine clients.
|
||||
# `docs/2-handbook/swarm/sso.md`, § Machine clients.
|
||||
#
|
||||
# Fed to the option as a DEFINITION in the config block below, rather
|
||||
# than appended to the declared list downstream. That is what puts it
|
||||
|
|
@ -329,7 +329,7 @@ let
|
|||
};
|
||||
|
||||
# Derived from the client list rather than carrying its own `enable`;
|
||||
# `docs/swarm/sso.md` says why that is one fact instead of two.
|
||||
# `docs/2-handbook/swarm/sso.md` says why that is one fact instead of two.
|
||||
#
|
||||
# ⚠️ In practice this is now unconditionally `true` whenever the module
|
||||
# is enabled: `bridgeClient` above is an unconditional definition of
|
||||
|
|
@ -986,7 +986,7 @@ in
|
|||
# ⚠️ THIS IS A SECURITY BOUNDARY, not a tidy-up. Do not fold it back
|
||||
# into `/`: the friendly error page answers **200**, and
|
||||
# `auth_request` reads any 2xx as ACCESS GRANTED. Full consequence
|
||||
# list in `docs/swarm/sso.md`, § Machine callers must fail closed.
|
||||
# list in `docs/2-handbook/swarm/sso.md`, § Machine callers must fail closed.
|
||||
#
|
||||
# The split is by AUDIENCE, not by path list — including the login
|
||||
# page's own XHR. Enumerating individual endpoints would leave the
|
||||
|
|
|
|||
Loading…
Reference in a new issue