Skip to content

Commit ed01156

Browse files
committed
DOCS : index.qmd, README.md 개선 및 아올다 협업 내용 추가
- index.qmd: 아주대학교 소학회 아올다 협업 소개 섹션 추가 - README.md: 실제 프로젝트 구조 반영, 배포 방식을 GitHub Actions 기준으로 업데이트
1 parent 2b26627 commit ed01156

2 files changed

Lines changed: 51 additions & 76 deletions

File tree

README.md

Lines changed: 42 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,83 @@
1-
# OpenStack 실습 데모 페이지 with Quarto
1+
# OpenStack Korea Community Book
22

3-
Quarto를 이용한 OpenStack Korea Community 의 Book 컨텐츠 프로젝트입니다.
3+
OpenInfra Korea User Group과 **아주대학교 소학회 아올다**([aoldacloud.com](http://aoldacloud.com/))가 함께 만드는 오픈스택 학습 자료입니다.
44

5-
## Quarto를 이용한 Book 프로젝트 구조
5+
Quarto를 이용해 작성하며, GitHub Actions를 통해 [book.openinfra-kr.org](https://book.openinfra-kr.org)에 자동 배포됩니다.
6+
7+
## 프로젝트 구조
68

79
```
810
.
9-
├── _quarto.yml # Quarto 설정 파일
10-
├── index.qmd # 메인 페이지
11-
├── lectures/ # 강의 자료
12-
│ ├── short_lec.qmd # 단편 강의자료
13-
│ ├── long_lec/ # 장편 강의자료
14-
│ │ └── long_lec1.qmd # 장편 강의자료 속편
15-
│ └── long_lec.qmd # 장편 강의자료 메인페이지 (소개, 속편 링크 가이드)
16-
├── community.qmd # 커뮤니티 페이지
17-
├── styles.css # 커스텀 스타일
18-
└── docs/ # 빌드된 사이트 (자동 생성)
11+
├── _quarto.yml # Quarto 설정 파일
12+
├── index.qmd # 메인 페이지
13+
├── custom.scss # 커스텀 스타일
14+
├── _footer.html # 공통 푸터
15+
├── lectures/ # 강의 자료
16+
└── .github/workflows/
17+
└── publish.yml # GitHub Actions 배포 워크플로우
1918
```
2019

21-
## 기여 시작하기
20+
> `docs/`는 빌드 결과물로 git에서 제외됩니다. GitHub Actions가 자동으로 빌드 후 `gh-pages` 브랜치에 배포합니다.
2221
23-
1. Quarto 설치
22+
## 로컬 개발 환경 설정
2423

25-
```
24+
### Quarto 설치
25+
26+
```bash
2627
# macOS
2728
brew install quarto
2829

2930
# Windows
3031
choco install quarto
3132

3233
# Linux
33-
wget https://github.com/quarto-dev/quarto-cli/releases/download/v1.6.0/quarto-1.6.0-linux-amd64.deb
34-
sudo dpkg -i quarto-1.6.0-linux-amd64.deb
34+
wget https://github.com/quarto-dev/quarto-cli/releases/latest/download/quarto-linux-amd64.deb
35+
sudo dpkg -i quarto-linux-amd64.deb
3536
```
3637

37-
## 강의 및 실습 가이드 기여 방법
38-
39-
### Github Issue 생성
40-
41-
1. .qmd 파일 생성하기
42-
43-
```
44-
---
45-
title: "페이지 제목"
46-
---
47-
48-
# 내용 작성
49-
```
50-
51-
2. `_quarto.yml`에 네비게이션 추가
52-
53-
```
54-
website:
55-
navbar:
56-
left:
57-
- text: "새 메뉴"
58-
file: path/to/new.qmd
59-
```
60-
61-
62-
### 강의 자료 추가
63-
64-
1. PDF 파일을 `media/pdf/` 디렉토리에 저장
65-
2. `lectures/<lecutre>.qmd`에 링크 추가
66-
67-
## 사이트 빌드 및 배포
68-
6938
### 로컬 프리뷰
7039

71-
```
40+
```bash
7241
quarto preview
7342
```
7443

75-
### 사이트 빌드
44+
### 빌드
7645

77-
```
46+
```bash
7847
quarto render
7948
```
8049

81-
빌드된 파일은 `docs/` 디렉토리에 생성됩니다.
50+
## 기여 방법
8251

83-
### GitHub Pages 배포
84-
85-
1. `docs/` 디렉토리를 Git에 커밋
86-
2. GitHub 저장소 설정에서 GitHub Pages 소스를 `docs/` 폴더로 설정
52+
### 강의 자료 추가
8753

88-
## 다국어 지원
54+
1. `lectures/` 아래에 `.qmd` 파일 생성
8955

90-
한글 콘텐츠 작성을 위해 `_quarto.yml`에 다음 설정이 되어있습니다:
56+
```markdown
57+
---
58+
title: "페이지 제목"
59+
---
9160

61+
# 내용 작성
9262
```
93-
format:
94-
html:
95-
lang: ko
63+
64+
2. `_quarto.yml``sidebar.contents`에 항목 추가
65+
66+
```yaml
67+
- text: "새 강의 제목"
68+
file: lectures/new_lec.qmd
9669
```
9770
71+
3. PR 생성 → 머지되면 자동 배포
9872
99-
## 문서 스타일 가이드
73+
### 이미지 파일
10074
101-
- 제목은 `#`부터 시작
102-
- 코드 블록은 ``` 사용
103-
- 이미지는 `images/` 디렉토리에 저장
104-
- 링크는 상대 경로 사용
75+
이미지는 해당 강의 디렉토리의 `images/` 폴더에 저장하고 상대 경로로 참조합니다.
10576

106-
## 도움말
77+
## 배포
10778

108-
- [Quarto 공식 문서](https://quarto.org/docs/guide/)
109-
- [GitHub Discussions](https://github.com/openstack-kr/community-site/discussions)
110-
- [Slack 채널](https://openstack-kr.slack.com)
79+
`main` 브랜치에 push하면 GitHub Actions가 자동으로 빌드 후 `gh-pages` 브랜치에 배포합니다.
11180

11281
## 라이선스
11382

114-
이 프로젝트는 MIT 라이선스 하에 배포됩니다.
83+
이 프로젝트는 MIT 라이선스 하에 배포됩니다.

index.qmd

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,29 @@ title: "OpenStack Korea Community"
66

77
OpenStack Korea Community에 오신 것을 환영합니다. 이 사이트는 오픈스택을 학습하는데 필요한 다양한 강의 자료들을 제공합니다.
88

9+
## 함께 만드는 곳
10+
11+
이 콘텐츠는 **OpenInfra Korea User Group****아주대학교 소학회 아올다**가 함께 만들어가고 있습니다.
12+
13+
[아올다(Aolda)](http://aoldacloud.com/)는 아주대학교의 클라우드 인프라 소학회로, 오픈스택을 비롯한 오픈소스 인프라 기술을 함께 배우고 실습하는 모임입니다.
14+
915
## 주요 콘텐츠
1016

11-
### 🎓 기초 학습
17+
### 기초 학습
1218
- [오픈스택 개요](lectures/ch1_lec.qmd)
1319
- 클라우드 컴퓨팅의 기본 개념
1420
- 오픈스택 프로젝트 소개
1521
- 주요 컴포넌트 설명
1622

17-
### ⚙️ 설치 가이드
23+
### 설치 가이드
1824
- [DevStack 설치 가이드](lectures/ch2/ch2_1_lec.qmd)
1925
- 개발 및 테스트 환경 구성
2026
- 단일 노드 설치 방법
2127
- [Kolla-Ansible 설치 가이드](lectures/ch2/ch2_2_lec.qmd)
2228
- 프로덕션 환경 구성
2329
- 멀티 노드 클러스터 구축
2430

25-
### 👥 커뮤니티 활동
31+
### 커뮤니티 활동
2632
- [Discord](https://discord.gg/3ZzKMJKtPg)에서 실시간 대화에 참여하세요
2733
- [커뮤니티 포럼](https://forum.openinfra-kr.org/)에서 질문하고 답변하세요
2834

0 commit comments

Comments
 (0)