Skip to content

docs: deepen tenancy + menus guides; natural KO phrasing#64

Merged
jlc488 merged 1 commit into
mainfrom
docs/feature-guides-deepen
Jun 3, 2026
Merged

docs: deepen tenancy + menus guides; natural KO phrasing#64
jlc488 merged 1 commit into
mainfrom
docs/feature-guides-deepen

Conversation

@jlc488

@jlc488 jlc488 commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

EN

Deepens the Multi-tenancy and Dynamic Menus guides to the same beginner, step-by-step depth as the tutorial, and fixes awkward literal-translation Korean.

Multi-tenancy (guides/tenancy)

  • single vs multi mode table + when to use each
  • resolver table (fixed/header/jwt/subdomain) with a header curl
  • TenantContextHolder.current() used in a real InvoiceService
  • the tenant-scoped @Entity + repository pattern (findByTenantId)
  • a custom TenantResolver bean (ApiKeyTenantResolver)
  • cross-links to the admin console + configuration reference

Dynamic Menus (guides/menus)

  • a mental-model diagram (define once → kit filters per user → you render)
  • Step 1 — define an item: console + REST tabs, with the real CreateMenuRequest fields (code / label / path / icon / requiredPermission / displayOrder / parentId)
  • Step 2/api/nav via MenuProvider.menusFor(...) + the actual MenuTree JSON shape
  • Step 3 — a minimal Vue render snippet
  • caching + direction-of-dependency notes

Both guides EN + KO, with full file paths in every code block.

Phrasing / anchors

  • replaced the literal 0에서 실행까지 ("zero to running") with natural Korean in the tutorial title, the admin-console link, and the mkdocs ko nav
  • pinned ASCII anchors { #menus } { #tenants } (admin-console.ko) and { #abac-policies } (access.ko) so EN-style fragment links resolve in the KO build — Korean is stripped from the auto-slug — and fixed the pre-existing broken access.md#abac-정책 link

Verification: mkdocs build --strict — clean, no anchor/link warnings.

KO (한국어)

멀티테넌시·동적 메뉴 가이드를 튜토리얼과 같은 초보자용 step-by-step 깊이로 보강하고, 어색한 직역 한국어를 자연스럽게 고쳤습니다.

멀티테넌시 (guides/tenancy)

  • single vs multi 모드 표 + 언제 무엇을
  • 리졸버 표(fixed/header/jwt/subdomain) + 헤더 curl
  • 실제 InvoiceService에서 TenantContextHolder.current() 사용
  • 테넌트 격리 @Entity + 리포지토리 패턴(findByTenantId)
  • 커스텀 TenantResolver(ApiKeyTenantResolver)
  • 관리자 콘솔 · 설정 레퍼런스 상호 링크

동적 메뉴 (guides/menus)

  • 개념 다이어그램(한 번 정의 → kit이 사용자별 필터 → 화면 렌더)
  • 1단계 — 항목 정의: 콘솔 + REST 탭, 실제 CreateMenuRequest 필드 포함
  • 2단계MenuProvider.menusFor(...)/api/nav + 실제 MenuTree JSON 형태
  • 3단계 — 최소 Vue 렌더 스니펫
  • 캐싱 + 의존 방향 노트

두 가이드 모두 한/영, 모든 코드 블록에 전체 파일 경로.

표현 / 앵커

  • 튜토리얼 제목·admin-console 링크·mkdocs ko nav의 직역 0에서 실행까지를 자연스러운 한국어로 교체
  • ko 자동 slug에서 한글이 떨어지는 문제 때문에, EN식 fragment 링크가 ko 빌드에서 동작하도록 ASCII 앵커 { #menus } { #tenants }(admin-console.ko)·{ #abac-policies }(access.ko)를 고정하고, 기존에 깨져 있던 access.md#abac-정책 링크를 수정

검증: mkdocs build --strict — clean, 앵커/링크 경고 없음.

Beginner-grade rewrite of the multi-tenancy and dynamic-menus guides to
tutorial-level depth, matching the verified runtime APIs.

tenancy:
- single vs multi mode table; resolver table (fixed/header/jwt/subdomain)
  with a header curl example
- TenantContextHolder.current() usage in an InvoiceService
- tenant-scoped @entity + repository pattern (findByTenantId)
- a custom TenantResolver bean (ApiKeyTenantResolver)
- admin-console + configuration cross-links

menus:
- mental-model diagram (define once -> kit filters -> you render)
- Step 1 define an item: console + REST tabs with the real
  CreateMenuRequest fields (code/label/path/icon/requiredPermission/
  displayOrder/parentId)
- Step 2 /api/nav serving via MenuProvider.menusFor + the MenuTree JSON
  shape; Step 3 a minimal Vue render snippet
- caching + direction-of-dependency notes

Both guides EN + KO, full file paths in every code block.

Phrasing/anchors:
- replace literal "0에서 실행까지" (zero-to-running) with natural Korean
  in the tutorial title, admin-console link, and mkdocs ko nav
- pin ASCII anchors { #menus } { #tenants } on admin-console.ko.md and
  { #abac-policies } on access.ko.md so EN-style fragment links resolve
  in the KO build (Korean is stripped from auto-slugs); fix the
  pre-existing access.md#abac-정책 broken link in admin-console.ko.md

Verification: mkdocs build --strict clean, no anchor/link warnings.
@jlc488 jlc488 merged commit 98a20e1 into main Jun 3, 2026
2 checks passed
@jlc488 jlc488 deleted the docs/feature-guides-deepen branch June 3, 2026 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant