docs: beginner end-to-end tutorial + fix incorrect ABAC/login examples#60
Merged
Conversation
Adds a zero-to-running Tutorial (en/ko) — a complete copy-paste walkthrough for someone new to the kit: create the project, run Postgres via Docker Compose, configure, boot, log in, create a permission/role/user, protect an endpoint, scope data to the tenant, and add an ABAC policy. Wired into the mkdocs nav. Also fixes stale/incorrect code in existing docs (would not compile / 401): - access.md (en/ko): the ABAC example used a `PolicyEvaluator` shape + an 8-arg `new PolicyContext(...)` that don't exist. Corrected to the real pattern — implement a `Policy` bean (the kit's DefaultPolicyEvaluator dispatches by name) and build the context with `PolicyContext.builder()`. - quick-start.md (en/ko): the login example used `password`; the field is `rawPassword`. All verified against the 0.4.2 API and a working consumer setup. `mkdocs build --strict` passes.
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.
Docs overhaul, PR 1 of N (the rest expand each guide to beginner depth).
New: a zero-to-running Tutorial (en/ko)
A complete copy-paste walkthrough for someone who has never used the kit — create the project, run Postgres via Docker Compose, configure, boot, log in, create a permission/role/user, protect your own endpoint, scope data to the tenant, and add an ABAC policy. Every command and file shown in full; verified against a working 0.4.2 consumer. Wired into the mkdocs nav.
Fixes: stale/incorrect examples (would not compile / 401)
access.md(en/ko) ABAC — the example used aPolicyEvaluatorshape and an 8-argnew PolicyContext(...)that don't exist. Corrected to the real pattern: implement aPolicybean (the kit'sDefaultPolicyEvaluatordispatches by name) + build the context withPolicyContext.builder().quick-start.md(en/ko) login — usedpassword; the field israwPassword.mkdocs build --strictpasses.문서 전면 개편 PR 1/N. 0→실행 초보 튜토리얼(en/ko) 신규 + 실제 API와 안 맞던 예제 정정(access.md ABAC: 실제
Policy빈 +PolicyContext.builder(); quick-start 로그인password→rawPassword).mkdocs build --strict통과. 나머지 가이드 심화는 후속 PR.