docs: document the Zitadel service identity and trim the generated specs - #32
Merged
Merged
Conversation
The reporter no longer signs an HMAC JWT with a shared secret, it obtains a Zitadel access token for a machine user through the JWT Profile flow. - rewrite doc/api/authentication.md around the key file, the assertion and the token endpoint, and name the scopes a deployment has to request - document the required oidc_issuer, oidc_key_file and oidc_scopes keys, drop the status_dashboard.secret examples and regenerate the config schema - follow the rename through the reporter, config, deployment, troubleshooting and architecture pages
The repository carried 667 kB of markdown under `doc/` and `specs/` next to 158 kB of Rust source. Two parts of it are redundant: `specs/` holds the generated design artifacts of three past features (they restate what the code and `doc/` already say, and two of them still describe the V1 API and the HMAC flow), and `doc/modules/` restates module signatures that the source and `doc/reporter.md` cover, with an example that no longer compiles. - remove `specs/` (feature plans, tasks, checklists and API contracts) - remove `doc/modules/` and the module section of the summary - point the project structure, quickstart and README pages at the architecture page and `cargo doc` instead - fix the relative link to the architecture page in the quickstart
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation only, no code change.
oidc_issuer,oidc_key_fileandoidc_scopeskeys, and regenerate the config schema (this is the documentation the reporter change needs, so it can land before it)specs/(the generated feature artifacts of three past features, two of them still describing the V1 API and the HMAC flow) anddoc/modules/(module signatures duplicated from the source, one example no longer compiles), and repoint the pages that linked to themVerification:
cargo test --test documentation_validationandmdbook build doc/(allSUMMARY.mdtargets exist, no remaining links into the removed folders).