docs: deepen audit + cache guides#65
Merged
Merged
Conversation
Bring the audit-logging and caching guides to the same beginner,
step-by-step depth as the tutorial, with verified APIs and full file
paths in every code block.
audit:
- fix the incomplete example: the previous AuditEvent.builder() snippet
was comment-only ("action / target / outcome — see the builder"); now
a complete, compiling call with real fields
- correct a wrong claim: occurredAt is REQUIRED (build() throws on null)
and actor is NOT auto-filled from context — the publisher just forwards
to an async executor and the listener stores actor as-is
- field table (action/occurredAt/target/outcome/actor/metadata/ip/ua),
AuditOutcome is SUCCESS|FAILURE
- read-the-trail: console + REST tabs (curl to /admin/api/v1/audit-logs)
cache:
- plain-language intro (what a cache is, one-property swap)
- application.yml path + the spring.data.redis block redis needs
- @Cacheable AND @CacheEvict example with file path
- "confirm it's caching" tip (log on miss / redis-cli KEYS)
Both guides EN + KO. Also pin { #audit-logs } on admin-console.ko.md so
the EN-style fragment link resolves in the KO build.
Verification: mkdocs build --strict clean, no anchor/link warnings.
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
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.
EN
Brings the Audit Logging and Caching guides to the same beginner, step-by-step depth as the tutorial, with verified APIs and full file paths in every code block.
Audit (
guides/audit)AuditEvent.builder()snippet was comment-only (// action / target / outcome — see the builder) — now a complete, compiling call with real fields.occurredAtis required (build()throws on null) andactoris not auto-filled from the security context — the publisher just forwards to an async executor and the listener storesactoras-is. The guide now says so explicitly.action/occurredAt/target/outcome/actor/metadata/ip/userAgent);AuditOutcomeisSUCCESS|FAILUREcurlto/admin/api/v1/audit-logs)Cache (
guides/cache)application.ymlpath + thespring.data.redisblock the redis backend needs@Cacheableand@CacheEvictexample with file pathredis-cli KEYS)Both guides EN + KO.
Also pins
{ #audit-logs }onadmin-console.ko.mdso the EN-style fragment link resolves in the KO build.Verification:
mkdocs build --strict— clean, no anchor/link warnings.KO (한국어)
감사 로깅·캐시 가이드를 튜토리얼과 같은 초보자용 step-by-step 깊이로, 검증된 API와 모든 코드 블록의 전체 파일 경로로 보강.
감사 (
guides/audit)AuditEvent.builder()스니펫은 주석만 있었음 — 이제 실제 필드로 컴파일되는 완전한 호출.occurredAt은 필수(null이면build()예외),actor는 보안 컨텍스트에서 자동으로 안 채워짐 — publisher는 비동기 executor로 넘기기만 하고 리스너는actor를 그대로 저장. 가이드에 명시.action/occurredAt/target/outcome/actor/metadata/ip/userAgent);AuditOutcome은SUCCESS|FAILURE/admin/api/v1/audit-logscurl)캐시 (
guides/cache)application.yml경로 + redis 백엔드가 필요로 하는spring.data.redis블록@Cacheable및@CacheEvict예제redis-cli KEYS)두 가이드 모두 한/영.
ko 빌드에서 EN식 fragment 링크가 동작하도록
admin-console.ko.md에{ #audit-logs }고정.검증:
mkdocs build --strict— clean, 앵커/링크 경고 없음.