AWS 도움말 문서, GitHub에서 오픈 소스로 공개
올해 초, AWS SDK 개발자 가이드를 제작해 GitHub repo(모두 awsdocs 조직에 있음)로 제공했으며, 관심 있는 사람은 누구나 풀 요청(pull request)의 형태로 문서를 변경하고 개선하는 데 참여할 수 있습니다.
여기에 오늘 개발자 가이드와 사용 설명서 138개를 조직에 추가하며, 앞으로도 여러분의 요청을 받고자 합니다. 버그를 수정하고, 코드 샘플을 개선하거나 새 코드 샘플을 제출하고, 세부 정보를 추가하며, 문장과 단락을 다듬어 정확성이나 명확성을 높일 수 있습니다. 커밋 기록을 확인하여 새로운 기능 및 서비스의 발표에 대해 자세히 알아보고 문서의 개정 내역을 추적할 수 있습니다.
문서 공헌 참여하기
시작하기 전에 Amazon 오픈 소스 약관을 읽고 해당 AWS 서비스의 참여 가이드 문서(일반적으로 CONTRIBUTING.md라는 이름의 문서)를 살펴보시기 바랍니다. 그런 다음 GitHub 계정이 없으면 하나 만듭니다.
변경하거나 개선할 내용이 발견되면 문서의 HTML 버전에서 페이지 상단에 있는 Edit on GitHub 버튼을 클릭합니다.
그러면 소스 형태(일반적으로 Markdown 또는 reStructuredText)로 문서를 편집할 수 있습니다. 이 소스 코드는 문서의 HTML, PDF 및 Kindle 버전을 제작하는 데 사용됩니다.
GitHub에 접속한 후 연필 아이콘을 클릭합니다.
그러면 “fork”가 생성됩니다. fork는 개별적으로 편집할 수 있는 별도의 파일 사본입니다.
그런 다음 원하는 대로 편집합니다. 일반적으로, 여러분은 오픈 소스 프로젝트의 신규 참여자로서 작지만 질 높은 편집 건을 통해 경험과 명성을 쌓아야 합니다. 이 문서에서 “dozens of services”라는 표현을 “over one hundred services”로 바꾸어 보겠습니다.
그런 다음 변경 내용의 요약 정보를 입력하고 Propose file change를 클릭합니다.
차이점을 통해 변경 내용을 확인한 후 Create pull request를 클릭합니다.
그런 다음 세부 정보를 검토하고 Create pull request를 다시 한 번 클릭합니다.
PR이라고도 하는 풀 요청은 Elastic Beanstalk 문서 팀에 전달되며, 이 팀에서 요청을 수락할지, 거절할지, 아니면 자세히 알아보기 위해 요청자와 대화할지를 결정합니다. 이 팀에서는 가급적 48시간 이내에 PR에 응답하며, PR의 상태가 변경되면 GitHub를 통해 요청자에게 알림이 전송됩니다.
여타의 오픈 소스 프로젝트와 마찬가지로 집중적이고 적당한 크기의 풀 요청이 꾸준히 들어오는 편이 수십 건의 편집 내용이 포함된 큰 요청이 가끔씩 들어오는 것보다 낫습니다.
repo를 시간의 경과에 따른 살펴볼 생각이라면 Watch 및/또는 Star 메뉴를 사용하면 됩니다.
repo를 Watch하는 경우 해당 서비스 가이드와 관련한 새 릴리즈, 발행 또는 풀 요청이 있을 때마다 이메일을 받게 됩니다.
Fork하기
AWS를 개선하는 데 참여할 수 있는 새로운 기회가 열렸습니다. 여러분의 생각을 알려주십시오!
— Jeff;
Source: AWS 도움말 문서, GitHub에서 오픈 소스로 공개
Leave a Reply