당신은 github사용할 떄 README.md 파? wiki파?

소스에 코멘트를 달다보면 끝이 없기 때문에 

상세사양을 따로 적습니다.

여러분은 github의 README.md 에 상세를 기입하시나요?

아니면 github의 wiki에 상세를 기입하시나요?

여기서 명확한 답이 아직 서지 않았는데..

README.md에 내용을 넣다보면

소스와 같이 관리되는 장점이 있지만, 

README.md만 갱신해도 commit회수가 늘어나고

지나치게 README.md가 늘어날 수가 있습니다. 

Func.md 등 여러 파일로 나누어 관리하는 것도 방법이지만, 

소스의 파일이 많아지게 되네요.

github wiki를 사용하게 되면

wiki에 걸맞는 여러가지 기능을 활용할 수 있는데.

(sidebar나 footer 등)

소스와 따로 관리를 하게 되므로

관리 포인트가 늘어납니다.

그래도 github답게 wiki조차도 

다른 git으로 통으로 내려받고 관리가 되네요.

MSA를 추구하게 되다보니 

저 같은 경우는 

root 디렉토리에서

공통 파일을 넣은 core.git과

각각의 모듈들을 각각의 directory로 관리합니다. 

관리가 쉽도록 

directory name = repository name

 으로 관리 중이구요..

(giip는 구 버전 구조라 service별로 쪼개지고 

virtual directory구조임)

무엇이 대세다..

라는 것은 웃기는 얘기구요..

대세 따라갈 실력도 없으면서

뭐 만든 사람이 했다 라는 이유로 맹목적으로 따라가는 것을 보면..

언제나 고민해야 하는 것은

이게 MSA가 되었을 때 

어떻게 활용해야 심플하면서 확장성이 높은가?

그리고 노드가 망가졌을 때 

다른 노드에 무엇만 올리면 되는가?

내가 100개의 노드를 가지고 있다면 이를 

MSA로 구성하게 되면

서버 구성도는 논리 구성도만 있으면 되게 되겠죠.

내가 원하는 노드에 올라간 마이크로서비스는 자연스럽게 

GLB를 통해 로드 밸런싱이 될테니..

(논리/물리 구성도의 차이를 모르시는 분이 아직도 많으신 듯..)

결국, 

저는 Wiki에 documentation을 충실히 하고

소스 및 README.md에는 wiki의 link만 넣고

서비스 Web에서도 help전용 Document Repository를 만들어 

wiki와 customize sample을 github를 통해 

제공하는 것으로 했습니다.

혹시 더 좋은 아이디어나 

자신히 했더니 이런것도 좋다 라는 팁이 있으면 

공유 부탁 드려요~

Do not login your server any more! 

Free server management tool! 

http://giipweb.littleworld.net

 Subscribe and publish your links as a book with friends 

My Favorite Link Share 

http://link.littleworld.net