Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wiki --> docs? #69

Closed
juice500ml opened this issue Feb 15, 2017 · 15 comments
Closed

wiki --> docs? #69

juice500ml opened this issue Feb 15, 2017 · 15 comments
Assignees

Comments

@juice500ml
Copy link
Member

  • wiki에는 안바뀌는 내용 (Project 소개나 syntax 정도?)
  • docs에는 바뀔 가능성 있는 내용

으로 하려는데, 어떤가요?

@fuzzythecat
Copy link
Member

네좋아여!

@punkyoon
Copy link
Member

좋습니다!

@punkyoon punkyoon mentioned this issue Mar 19, 2017
@punkyoon
Copy link
Member

punkyoon commented Apr 1, 2017

coding-night-live-doc

문서를 작성하다보면 괜한 프로젝트 파일만 더 무거워질 것 같습니다.

따로 doc repository를 두어 관리를 하려고 하는데, 어떠신가요?

@juice500ml @fuzzythecat @minhoryang @taeseunglee @AilisObrian

@juice500ml
Copy link
Member Author

juice500ml commented Apr 1, 2017 via email

@taeseunglee
Copy link
Member

@punkyoon 저도 docs 폴더 하나면 충분하다고 생각하는데, doc이 많이 무겁거나 그럴 예정인가요?

@punkyoon
Copy link
Member

punkyoon commented Apr 1, 2017

저희 프로젝트를 zip으로 다운 받으면 약 4.8MB의 용량을 차지하는 걸 확인할 수 있는데, docs에 있는 파일을 보면 무려 3.29MB나 차지하는 걸 확인할 수 있습니다...

물론 gif파일이 많아서 그런거지만, 사용자 입장에서 프로젝트를 다운받을 때 gif까지 설치할 필요가 있나 싶어서요..

또한, 저는 기존 wikireadthedocs로 서비스하는것까지 염두에 두고 있는데, 만약 해당 서비스를 이용하게 되면 저희 프로젝트에 포함되지 않았던 wiki문서들이 docs에 위치하게 됩니다. 이때문에 전체적인 프로젝트 용량은 더 무거워지겠죠!

그래서 docs를 아예 다른 repo로 분리하자는 뜻이였습니다!

@minhoryang
Copy link
Member

+1 to coding-night-live-doc!!

용량은 별 걱정거리는 아닌데요.
docs가 git이랑 같이 관리되야한다라는 공감대가 생겼다는게 매우 만족스럽습니다.
매 commit당 docs를 수정하는게 힘드니, repo를 나누고, 해당하는 버전을 명시하도록 -doc에 git hook을 걸어두면 매우 좋을 것 같습니다!

@juice500ml
Copy link
Member Author

ㅇㅋㅇㅋ 좋네요!

@punkyoon
Copy link
Member

punkyoon commented Apr 3, 2017

그러면 추후 프로젝트 관련 문서들은 coding-night-live-doc에서 관리하도록 하겠습니다..!

@fuzzythecat

@minhoryang
Copy link
Member

제가 coding-night-live-doc에 권한이 없는 것 같습니다 ㅠㅠ

@punkyoon
Copy link
Member

punkyoon commented Apr 11, 2017

@minhoryang dduk-ddak으로 초대해드릴까요..?!

@minhoryang
Copy link
Member

@punkyoon 아 이 repo에 권한이 있길래 제가 dduk-ddak에 속해있는건줄 알았어요!
초대해주시겠어요?

@punkyoon
Copy link
Member

@minhoryang 초대해드렸습니다!

@minhoryang
Copy link
Member

Yay!

@punkyoon
Copy link
Member

coding-night-live의 위키에는 안바뀌는 내용(Project 소개, syntax, ..)만 넣어두고,

바뀔 가능성이 있는 내용들은 coding-night-live-doc에서 관리하기로 하고, 이슈 닫겠습니다.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants