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

x86-8 문서 작성 규칙 #2

Open
hwiorn opened this issue Mar 23, 2013 · 2 comments
Open

x86-8 문서 작성 규칙 #2

hwiorn opened this issue Mar 23, 2013 · 2 comments

Comments

@hwiorn
Copy link
Contributor

hwiorn commented Mar 23, 2013

문서 작성 규칙을 약소하게 나마 정하는 편이 좋을 것 같아, 씁니다. 물론, 저 혼자 확정하는 것이 아니므로, 언제든 의견 주세요.

자료 내용 정의

  1. 공개하기 꺼려지는 내용
    • 확정되지 않은 토론 및 내용
    • 참고할 자료
  2. 공개해도 될 자료
    • 정리되거나 될 자료(양에 상관 없음)

자료 작성 규칙

  • 형식 무관
  • 인용 시, 출처 및 참고자료 (책, 링크, PDF) 를 반드시 삽입(카더라 자제)

방침

공개하기 꺼려지는 내용(이하 1번)의 경우는 github issues 그룹 메일링 리스트 를 이용해 주시기 바랍니다. iamroot 게시판을 사용하려고 했었지만, 아는 사람에게 도움을 받을 수 있다는 점보단, 불필요하게 공개된다는 점이 있고, 딱히 멤버 이외 사람들과 토론이 일어나지 않기 때문입니다. 이 부분에 있어서는 메일링 리스트를 도입하는 게 어떨까 싶었지만, 이미 issues가 그런 역할(새로운 issue 발생 시, watch를 한 이에게 메일 전송)을 하므로, 참고 하시기 바랍니다.

Issues 기능을 사용하여, mailing list를 사용하려 했지만, 메일이 제때 또는 아예 전송이 되지 않는 것으로 보여, mailing list를 만들었습니다.
https://groups.google.com/forum/?fromgroups#!forum/kernel-x86-8-study-group

공개해도 될 자료(이하 2번)의 경우는 github wiki 를 이용해 주시기 바랍니다. 해당 내용은 정리가 되거나, 체계가 잡힌 내용 등을 쓰시면 될 것 같고, iam root 게시판에도 같이 올리시면 될 것 같습니다. iam root에 이중으로 올리는 단점이 있지만, 현 상황은 공부하며 나오는 사소한 토론보단, 뭔가 체계적인 내용을 올려야 할 것 같은 분위기가 있어서, 이런 식으로 하는 것이 좋을 듯 합니다

분위기 문제는 레벨이 지나치게 높다는 주제로, 대상이 좀 다르지만 iamroot 오프 토론에서도 언급되었던 것으로 기억합니다.

혹시나, 자료를 블로그에 올리고, wiki에 올리시는 경우엔 wiki 문법이 있으므로,

  • wiki 문법(github에서는 markdown 문법) 을 맞춘다.
  • 자신의 blog에 올리고 wiki에 링크를 건다.

자유롭게 작성합시다 👍

중 에서 자유로운 선택을 하시면 될 것 같습니다.

자료 공개 흐름

  • 1번(자유로운 토론을 통해)에서, 2번으로 정리 및 전이.
  • 개인적인 공부를 통해, 만들어진 자료를 2번으로 공개.

참고 사항

  1. blog 또는 문서 작성 시, 형식 무관.
  2. Wiki에 직접 작성 시, 형식을 지킵니다. 또 양에 상관 없이, 자유롭게 작성하며(중복 내용 가능), 타인이 작성한 wiki의 내용이 수정이 필요한 경우(틀렸거나, 바뀌었거나), 삭제보다, 수정 표시(strike 서식 후에 글 추가 또는 글 삽입) 를 추가 합니다.
  3. 최대한 중복 페이지가 없으면 좋으나, 각 멤버들의 생각이 동일하지 않기 때문에, 해당 부분에 대해 자신이 분석한 내용 또는 생각에 내용에 대해서 중복 페이지 생성은 규정하지 않습니다.
    • A가 작성한 booting 시퀀스 분석
    • B가 작성한 booting 시퀀스 분석

누군가의 옳다 또는 틀렸다 는 정의로 인해, 하나의 자료로 만들어지는 것은 옳지 않다고 봅니다.

  1. 각 저장소(linux3.2, linux3.7)의 wiki에는 해당 버전의 분석된 자료에 대해서 올리는 것을 원칙으로 합니다.(현재 3.7에서 작성하고 있으니, 3.7이 맞겠죠)

개인적으론 x86-8-docs의 Wiki에 정리된 자료를 올리는 게 맞겠지만, 현재 study group의 context에 맞게 진행하는 것이 옳을 지도 모르겠습니다. 언젠가, x86-8-docs 에 정리된 자료가 모여서 누군가 에게 링크를 던져주는 날이 오기를 기대해봄 직합니다. :)

@hwiorn
Copy link
Contributor Author

hwiorn commented Mar 23, 2013

메일을 구독하는 방법x86-8/linux-3.7 저장소에서 Watch 를 해도 되지만, 아래 링크로 가서 Watching를 선택하시면 됩니다

https://github.com/x86-8/linux-3.7/subscription

Issues가 메일링 리스트로서 제대로 역할을 하지 못해서, 메일링 리스트를 만들었습니다.
https://groups.google.com/forum/?fromgroups#!forum/kernel-x86-8-study-group

x86-8 전체 저장소의 issue들 을 보려면 아래 링크를 보면, 우리 그룹의 이슈들을 한번에 볼 수 있어 좋습니다 👍
https://github.com/organizations/x86-8/dashboard/issues

@hwiorn
Copy link
Contributor Author

hwiorn commented Mar 24, 2013

Issues가 메일링 리스트로서 제대로 역할을 하지 못해서, 메일링 리스트를 만들었습니다.
https://groups.google.com/forum/?fromgroups#!forum/kernel-x86-8-study-group

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

1 participant