๐ ๋ธ๋ก๊ทธ ๐ ๊นํ๋ธ ๋ธ๋ก๊ทธ - utterances๋ฅผ ์ด์ฉํ ๋๊ธ ๊ธฐ๋ฅ ์ถ๊ฐ
[blog] utterances๋ฅผ ์ด์ฉํ ๋๊ธ ๊ธฐ๋ฅ ์ถ๊ฐ
๋ด ๊นํ๋ธ ๋ธ๋ก๊ทธ์ ๋๊ธ ๊ธฐ๋ฅ์ ์ถ๊ฐํด๋ณด์.
utterances๋ฅผ ์ด์ฉํ ๋๊ธ ๊ธฐ๋ฅ ์ถ๊ฐ ๋ฐฉ๋ฒ
1. ๋๊ธ๊ธฐ๋ฅ์ ์ํ Repository ์์ฑ
๊นํ๋ธ์ ์ ์ํ์ฌ utterances์ ์ฐ๊ฒฐํ ์๋ก์ด Repository๋ฅผ public์ผ๋ก ๋ง๋ค์ด ์ค๋ค.
(๋๊ธ ๊ธฐ๋ฅ์ ์ฌ์ฉํ ๋งํ ๋ ํฌ์งํ ๋ฆฌ๊ฐ ์ด๋ฏธ ์๋ค๋ฉด ์กด์ฌํ๋ ๋ ํฌ์งํ ๋ฆฌ๋ฅผ ์ฌ์ฉํด๋ ๋ฌด๋ฐฉํ๋ค๊ณ ํ๋ค. ์ฆ, ๊ทธ๋ฅ ๊นํ๋ธ ๋ธ๋ก๊ทธ ๋ ํฌ์งํ ๋ฆฌ๋ฅผ ์ฌ์ฉํด๋ ๋ฌด๋ฐฉํ ๊ฒ ๊ฐ๋ค.)
2. Utterances ์ค์น
https://github.com/apps/utterances
์ ์ฃผ์์ ์ ์ํ์ฌ utterances๋ฅผ Install ํ๋ค.
์ด ๋, ๋๊ธ์ด ๋ฌ๋ฆฌ๋ฉด ๋ชจ๋ Repository์ Issue์ ์ ๋ก๋๋๊ฒ ํ ์ง, ํน์ ํน์ Repository์ Issue์๋ง ์ ๋ก๋๋๊ฒ ํ ์ง ์ ํํ ์ ์๋ค.
๋๋ ์๋ก ์์ฑํ ๋๊ธ์ฉ ๋ ํฌ์งํ ๋ฆฌ์๋ง ์ ๋ก๋๋๋๋ก ํ๊ธฐ ์ํด ์๋์ ๊ฐ์ด โOnly select repositoriesโ ์ ์ฒดํฌ ํ ํด๋น ๋ ํฌ์งํ ๋ฆฌ๋ฅผ ์ ํํด์คฌ๋ค.
3. configuration ์ค์
install ํ ์๋์ ๊ฐ์ ํ์ด์ง๊ฐ ๋จ๋๋ฐ,
์๋ ํ์ํ ๋ถ๋ถ๋ค์ ์์ฑํด์ฃผ๋ฉด ๋๋ค.
- Repository
๊นํ๋ธ username/repository์ด๋ฆ ์ ์ ๋ ฅํด์ค๋ค.
์ฌ๊ธฐ์ repository๋ ์์์ ๋๊ธ Issue๊ฐ ์ ๋ก๋๋ ๊ณณ์ผ๋ก ์ ํํ repository๋ฅผ ์ ์ผ๋ฉด ๋๋ค.
- Blog Post - Issue Mapping
์ฌ๊ธฐ๋ ๋๊ธ Issue๋ฅผ ๋ธ๋ก๊ทธ ํฌ์คํธ์ ์ด๋ป๊ฒ ๋งคํ์ํฌ์ง๋ฅผ ์ ํ๋ ๋ถ๋ถ์ธ๋ฐ, ๋๋ ์ฒซ ๋ฒ์งธ ์ ํ์ง์ธ page pathname์ ์ ํํ๋ค.
๋งคํ์ํฌ key๋ ๋ณ๊ฒฝ๋์ง ์๋ ๊ฒ์ด ์ข์ผ๋ฏ๋ก, ๊ณ ์ ํ ์ฑ์ง์ ๊ฐ์ง๋ฉฐ ๊ฐ์ฅ ๋ณ๊ฒฝ๋ ํ๋ฅ ์ด ๋ฎ์ pathname์ผ๋ก ์ ํํ๋ ๊ฒ์ด ์ข๋ค๊ธฐ์ ๋๋ ๊ทธ๋ ๊ฒ ํ๋ค.
- Theme
ํ ๋ง ๋ณ๊ฒฝ์ ์ํ๋ ๋์์ธ์ผ๋ก ํด์ฃผ๋ฉด ๋๋ค.
๋๋ Photon Dark๋ผ๋ ํ ๋ง๋ฅผ ์ ํํ๋ค.
-
Enable Utterances
- 1) minimal-mistakes๋ฅผ ์ฌ์ฉ ์ค์ธ ๊ฒฝ์ฐ
- ๊นํ๋ธ ๋ธ๋ก๊ทธ์ _config.yml ํ์ผ ๋ด์ ์๋์ ๊ฐ์ด 4๊ฐ์ง ํญ๋ชฉ์ ์์ฑํด์ค๋ค.
repository: ๋๊ธ Issue๊ฐ ์ฌ๋ผ์ฌ ๊ณณ์ผ๋ก ์ ํํ ๊ทธ repository์ permalink (username/repository)๋ฅผ ์์ฑ
comments - provider: utterances ๋ผ๊ณ ์์ฑ
utterances - Theme: ์์์ ๊ณจ๋๋ ํ ๋ง. ๋๋ Photon Dark ์ ํ
utterances - issue_term: ์์์ ์ ํ๋ ๋งตํ ๋ฐฉ๋ฒ. ๋๋ pathname ์ ํ
- 2) ๊ทธ ์ธ์ ๊ฒฝ์ฐ
- ์๋ ์ฝ๋ ๋ถ๋ถ์ ๋ณต์ฌํ์ฌ ๋๊ธ ๊ตฌํ์ ๋ด๋นํ๋ html ํ์ผ์ ๋ถ์ฌ๋ฃ์ด์ฃผ๋ฉด ๋๋ค๊ณ โฆ ํ๋คโฆ.
์ด๋ ๊ฒ ํ๊ณ Commit and Push ํ์ฌ ์๋ฒ์ ๋ฐ์ํ๋ฉด ๋๊ธ๊ธฐ๋ฅ ์ถ๊ฐ๊ฐ ์๋ฃ๋๋ค.
๊ทผ๋ฐ..
์ฌ๊ธฐ๊น์ง ํ๋๋ฐโฆ
์ ๋์์ ? ? ?
_config.yml ํ์ผ ํ๋จ์ comments: # true ๋ถ๋ถ์ด ๋ฌธ์ ์์.
์๋์ ๊ฐ์ด # ์ ์ง์์ค์ผ ๋๊ธ ๊ธฐ๋ฅ์ด ์ ์ฉ๋๋ค! comments: true ๊ฐ ๋๋๋ก!
์ด์ ์ง์ง ๋~
utterences์ ๋์ ์๋ฆฌ
utterances๋ ๊นํ๋ธ ์ด์๋ฅผ ๊ธฐ๋ฐ์ผ๋ก ๋๊ธ์ ๋ฌ ์ ์๊ฒ ํด์ฃผ๋ ๊นํ๋ธ ์ฑ.
utterances๊ฐ ๋ก๋๋๋ฉด, ๊นํ๋ธ์ issue search API๋ฅผ ์ฌ์ฉํ์ฌ url, pathname, title์ ๊ธฐ์ค์ผ๋ก ํ์ด์ง(๊ธ)์ ๊ด๋ จ๋ ์ด์๋ฅผ ์ฐพ์ (๋ง์ฝ ํ์ด์ง์ ์ผ์นํ๋ ์ด์๊ฐ ์๋ ๊ฒฝ์ฐ utterances-bot์ด ์๋์ผ๋ก ์ด์๋ฅผ ์์ฑํจ),
ํด๋น issue์ ๋ฌ๋ฆฌ๋ ๋๊ธ์ Primer๋ฅผ ์ด์ฉํ์ฌ Github์ ์ ์ฌํ UI๋ก ๋ณด์ฌ์ค๋ค.
๊นํ๋ธ ๊ณ์ ๋ก๊ทธ์ธ์ ํตํด ๋๊ธ์ ๋ฌ ์ ์์ผ๋ฉฐ, ๋๊ธ์ด ๋ฌ๋ฆฌ๋ฉด Github Repository์ Issue๋ก ์๋ฆผ์ด ์ค๋ ์์คํ ์ด๋ค.
utterances์ ์ฅ์
- ๊ด๊ณ ๊ฐ ์๋ค
- ๋๊ธ์ ๋งํฌ๋ค์ด ๋ฌธ๋ฒ์ ์ฌ์ฉํ ์ ์๋ค
- ๊ฐ๋ณ๊ณ , ์ค์น ๋ฐ ์ค์ ์ด ์ฝ๋ค
- Github Issue์ ๋งตํ ํ ์ ์๋ค๋ฉด ์ด๋ ๊ณณ์์๋ ์ฌ์ฉํ ์ ์๋ค
- ๋๊ธ์ ๋จ๊ธฐ๊ธฐ ์ํด ๋ณ๋ ํ์๊ฐ์ ๋ฑ์ ํ ํ์๊ฐ ์๋ค (๊นํ๋ธ ๊ณ์ ๋ง ์์ผ๋ฉด ๋๋ค)
- ๋๊ธ ์๋ฆผ์ ๋ฐ์ ์ ์๋ค
๐ ๋ด์ฉ ์ค ์๋ชป๋ ๋ถ๋ถ์ด ์์ ๊ฒฝ์ฐ ์๋ ค์ฃผ์๋ฉด ๊ฐ์ฌ ๋๋ฆฌ๊ฒ ์ต๋๋ค.
๋๊ธ๋จ๊ธฐ๊ธฐ