TIL 210623

Facts

1. NestJs 세션 진행

2. Asciidoc 조사

 

Feelings

회사 동료분에게 NestJs 튜토리얼 세션을 진행했다. 내 지식을 설명하는 것은 어려운 일이지만 그만큼 재밌는 일이기도 하다. 문서화를 잘 해 둬야 겠다고 생각했는데 마침 asciidoc을 공부하게 됐다. 내가 작성한 코드를 다른사람이 쉽게 읽을 수 있도록 풀어 쓰는 것도 매력적인 일이라 느꼈다. 다음주부터는 개인 프로젝트를 진행할 것 같은데 javadoc 과 asciidoc 도 잘 작성하여 완성도 있는 서비스를 구현하고 싶다.

 

Finds

1. asciidoc을 작성하는 메커니즘, 원리

2. gitlab과 github 연동

- 미러링이라는 기술을 사용한다. 1) Gitlab 의 프로젝트를 클론 한 후, 2) github에 새로운 레포를 Private 으로 생성한다. 3) 아래의 명령어로 푸쉬하면 된다.

$ git push --mirror `github 새로운 레포 주소`

3. javadoc과 asciiDoc 차이

- javaDoc 은 주로 클래스와 메서드의 책임을 설명한다.

- asciiDoc 은 결국 Spring API doc 을 작성하는 도구이기 때문에, 주로 HTTP API 에 대한 설명을 이룬다. 프로젝트의 API spec 을 이해해야하는 프론트엔드 개발자 등이 주로 읽게 된다.