Skip to content

Commit

Permalink
update guide doc
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielwithappy committed Sep 3, 2023
1 parent d4ddf87 commit 462068e
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions glossary/guide.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ url: https://huggingface.co/docs/transformers/index

딥러닝 용어 사전은 `quarto`를 이용하여 작성되었습니다. [Quarto 웹사이트](https://quarto.org/docs/get-started/)로 이동하여 프로그램을 설치해주세요. 설치가 완료되었다면 이제 본격적으로 문서를 작성할 준비를 끝났습니다.

용어 사전의 구조를 살펴볼까요? 용어 사전에 작성된 용어들은 아래의 `terms`폴더에 하나의 파일 형태로 생성됩니다. 예를 들어 `convolution`을 수정하는 경우 `terms` 폴더에 생성된 `convolution.qmd`파일을 수정합니다. 신규 용어는 모두 소문자이며 공백은 `_`로 변경하여 파일명을 생성합니다. `terms`폴더에 새로운 파일이 추가된 이후 문서를 작성하는 부분은 수정과 동일합니다.파일명은 모두 `소문자`로 작성하고 공백은 `_`로 대체하여 사용하고 있습니다.
용어 사전의 구조를 살펴볼까요? 용어 사전에 작성된 용어들은 아래의 `terms`폴더에 하나의 파일 형태로 생성됩니다. 예를 들어 `convolution`을 수정하는 경우 `terms` 폴더에 생성된 `convolution.qmd`파일을 수정합니다.

```
├── glossary
Expand All @@ -46,6 +46,23 @@ url: https://huggingface.co/docs/transformers/index
| │ └── speech_enhancement.qmd
```

### 새로운 용어 작성

앗, 제가 찾는 용어가 없습니다! 새로운 용어를 등록하는 경우 `terms`폴더에 등록하려는 용어명과 동일한 파일명으로 `qmd`파일을 생성합니다.

::: {.callout-note}
## 신규용어 파일명 생성 규칙

- 신규 용어는 모두 소문자이며 공백은 `_`로 변경하여 파일명을 생성합니다.
- 파일명은 모두 `소문자`로 작성하고 공백은 `_`로 대체하여 사용하고 있습니다.
- 같은 파일명이 있는 경우 `_1`, `_2`와 같이 `postfix`를 붙여 추가합니다.
- `directory.qmd`
- `directory_1.qmd`
:::

신규 용어 파일명 생성 규칙에 맞게 파일을 생성한 후 문서 작성을 시작합니다.


## 문서 작성

딥러닝 용어사전은 깃헙 리포지토리(repository)로 관리되기 때문에 문서 작성을 위해서 Pseudo-Lab 깃 리포지토리를 Fork하여 문서를 작업합니다. Fork된 리포지토리에서 수정할 웹페이지의 html 파일명과 동일한 이름의 `qmd` 확장자 파일을 열어 문서를 수정할 수 있습니다.
Expand Down Expand Up @@ -89,4 +106,4 @@ PR(Pull Request)는 오픈소스 개발에서 주로 사용되는 개념입니

[^2]: https://won.hashnode.dev/a-comprehensive-guide-to-mastering-github-pr-reviews

[^3]: http://www.publickrdata.com/blog/74/
[^3]: http://www.publickrdata.com/blog/74/

0 comments on commit 462068e

Please sign in to comment.