mirror of
https://github.com/krahets/hello-algo.git
synced 2026-11-01 18:55:23 +08:00
Yudong Jin
2f561d3d51
* feat(ko): add the complete Korean online edition * Use UTF-8 for Python CI output on Windows * Remove print-book promotion from the Korean site * fix(ko): preserve emphasis before Korean particles
48 lines
2.9 KiB
Markdown
48 lines
2.9 KiB
Markdown
# 함께 만드는 책
|
||
|
||
저자의 역량이 부족하여 책에 누락이나 오류가 있을 수 있다는 점을 양해 부탁드린다. 오탈자, 끊어진 링크, 빠진 내용, 모호한 표현, 불분명한 설명, 부자연스러운 글의 구성 등을 발견했다면 수정에 힘을 보태 주기 바란다. 독자에게 더 좋은 학습 자료를 제공하는 데 큰 도움이 된다.
|
||
|
||
모든 [집필 참여자](https://github.com/krahets/hello-algo/graphs/contributors)의 GitHub ID는 저장소와 웹 버전의 첫 페이지에 표시된다. 이는 오픈 소스 커뮤니티에 아낌없이 기여한 분들에게 감사를 전하기 위한 것이다.
|
||
|
||
!!! success "오픈 소스의 매력"
|
||
|
||
종이책은 인쇄와 다음 인쇄 사이의 간격이 길어 내용을 갱신하기가 매우 불편하다.
|
||
|
||
반면 이 오픈 소스 도서에서는 내용을 갱신하는 데 걸리는 시간이 며칠, 때로는 몇 시간으로 줄어든다.
|
||
|
||
### 간단한 내용 수정
|
||
|
||
아래 그림과 같이 각 페이지의 오른쪽 위에는 ‘편집 아이콘’이 있다. 다음 순서로 글이나 코드를 수정할 수 있다.
|
||
|
||
1. ‘편집 아이콘’을 누른다. 저장소를 포크해야 한다는 안내가 나오면 동의한다.
|
||
2. Markdown 소스 파일을 수정하고 내용이 올바른지 확인한다. 서식은 가능한 한 일관되게 유지한다.
|
||
3. 페이지 아래쪽에 수정 내용을 설명하고 ‘Propose file change’ 버튼을 누른다. 이동한 페이지에서 ‘Create pull request’ 버튼을 누르면 풀 리퀘스트를 만들 수 있다.
|
||
|
||
|
||
|
||
그림은 직접 수정할 수 없으므로 [Issue](https://github.com/krahets/hello-algo/issues)를 만들거나 댓글로 문제를 설명해 주기 바란다. 확인 후 최대한 빨리 그림을 다시 제작하여 교체하겠다.
|
||
|
||
### 내용 작성
|
||
|
||
코드를 다른 프로그래밍 언어로 옮기거나 글의 내용을 확장하는 등 이 오픈 소스 프로젝트에 참여하고 싶다면 다음 풀 리퀘스트 절차를 따르면 된다.
|
||
|
||
1. GitHub에 로그인한 뒤 이 책의 [코드 저장소](https://github.com/krahets/hello-algo)를 개인 계정으로 포크한다.
|
||
2. 포크한 저장소의 웹페이지로 이동하여 `git clone` 명령으로 저장소를 로컬에 복제한다.
|
||
3. 로컬에서 내용을 작성하고 충분히 테스트하여 코드가 올바른지 검증한다.
|
||
4. 로컬 변경 사항을 커밋한 뒤 원격 저장소로 푸시한다.
|
||
5. 저장소 웹페이지를 새로 고침하고 ‘Create pull request’ 버튼을 눌러 풀 리퀘스트를 만든다.
|
||
|
||
### Docker 배포
|
||
|
||
`hello-algo` 루트 디렉터리에서 다음 Docker 명령을 실행하면 `http://localhost:8000/ko/`에서 한국어판을 열 수 있다.
|
||
|
||
```shell
|
||
docker-compose up -d
|
||
```
|
||
|
||
다음 명령으로 배포를 제거할 수 있다.
|
||
|
||
```shell
|
||
docker-compose down
|
||
```
|