Skip to content

Commit 41c7b36

Browse files
author
yeongseon
committed
feat: add metadata table include component
- Create _includes/metadata_table.html for tracking document freshness - Add example implementation in docs/policies/releases.md - Document usage pattern in CONTRIBUTING.md This implements the metadata foundation (#180) with opt-in strategy to avoid scope creep (#179). Metadata table can be added to new translations or updated documents without requiring repo-wide changes. Refs #180, #179
1 parent 4914184 commit 41c7b36

3 files changed

Lines changed: 76 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,43 @@ Azure SDK 프로젝트는 기여와 제안을 환영합니다. 대부분의 기
5252
- [ ] 오탈자, 띄어쓰기, 문장 호흡을 점검했는가?
5353
- [ ] `bundle exec jekyll build`로 로컬 빌드를 확인했는가?
5454

55+
#### 메타데이터 테이블 추가 (선택사항)
56+
57+
번역 문서에 원문 출처 및 최신성을 표시하려면 메타데이터 테이블을 추가할 수 있습니다.
58+
59+
**사용 방법:**
60+
61+
프론트매터 직후에 다음 include를 추가합니다:
62+
63+
```liquid
64+
---
65+
title: "문서 제목"
66+
permalink: doc_page.html
67+
folder: policies
68+
sidebar: general_sidebar
69+
---
70+
71+
{% include metadata_table.html
72+
original_title="Original Document Title"
73+
original_link="https://azure.github.io/azure-sdk/original_page.html"
74+
last_updated="2023-10-15"
75+
%}
76+
```
77+
78+
**파라미터:**
79+
- `original_title`: 원문 제목 (영문)
80+
- `original_link`: 원문 URL (Azure SDK 공식 문서)
81+
- `last_updated`: 마지막 번역 업데이트 날짜 (YYYY-MM-DD)
82+
83+
**적용 원칙:**
84+
- 새 번역 작업 시 추가 권장
85+
- 기존 문서 업데이트 시 선택적으로 추가
86+
- 과거 문서 일괄 변경은 하지 않음 (범위 확장 방지)
87+
88+
**예시:**
89+
90+
`docs/policies/releases.md` 파일 참고
91+
5592
### 커밋 메시지 컨벤션 (Commit Message Convention)
5693

5794
커밋 메시지는 **Conventional Commits** 형식을 사용합니다.

_includes/metadata_table.html

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{% comment %}
2+
Usage in markdown files:
3+
{% include metadata_table.html
4+
original_title="Azure SDK Design Guidelines"
5+
original_link="https://azure.github.io/azure-sdk/general_introduction.html"
6+
last_updated="2024-03-27"
7+
%}
8+
{% endcomment %}
9+
10+
<div class="metadata-table" markdown="1">
11+
12+
| Original Title | Original Link | Last Updated |
13+
| -------------- | ------------- | ------------ |
14+
| {{ include.original_title }} | [원본 문서]({{ include.original_link }}) | {{ include.last_updated }} |
15+
16+
</div>
17+
18+
<style>
19+
.metadata-table {
20+
margin-bottom: 2em;
21+
padding: 1em;
22+
background-color: #f8f9fa;
23+
border-left: 4px solid #007bff;
24+
}
25+
26+
.metadata-table table {
27+
margin-bottom: 0;
28+
}
29+
30+
.metadata-table td, .metadata-table th {
31+
padding: 0.5em;
32+
}
33+
</style>

docs/policies/releases.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ folder: policies
55
sidebar: general_sidebar
66
---
77

8+
{% include metadata_table.html
9+
original_title="Policies: Releases"
10+
original_link="https://azure.github.io/azure-sdk/policies_releases.html"
11+
last_updated="2023-10-15"
12+
%}
13+
814
Azure SDK에 대한 릴리스 정책은 기본 서비스의 배포 주기에 따라 다른 SDK 패키지를 릴리스해야 하는 필요성을 수용합니다.
915

1016
## Exit Criteria

0 commit comments

Comments
 (0)