웹 브라우저에서 단일 페이지 편집하기

웹 브라우저에서 단일 페이지 편집하기

웹 브라우저를 통해 EKS User Guide의 단일 페이지를 쉽게 편집할 수 있어요.

웹 브라우저에서 여러 페이지를 편집하려면 GitHub Web Editor로 웹 브라우저에서 여러 파일 편집하기를 참고하세요.

출처: 문서

본문

사전 조건 (Prerequisites)

  • 웹 브라우저에서 변경할 문서 페이지가 열려 있어야 합니다.
  • GitHub에 로그인되어 있어야 합니다.

절차 (Procedure)

  1. Amazon EKS User Guide에서 편집할 페이지로 이동합니다.
  2. 오른쪽 창에서 Edit this page on GitHub 링크를 선택합니다.
  3. GitHub에 도착하면 다음 중 하나로 편집기를 엽니다.
    • 키보드의 e 키를 누르기.
    • 연필 아이콘을 클릭하고 드롭다운 메뉴에서 Edit in Place 선택.
  4. 편집 옵션이 없다면 GitHub에 로그인해야 합니다. GitHub 계정에는 변경을 제안하는 데 특별한 권한이 필요하지 않아요. 다만 내부 Amazon 기여자는 GitHub 프로필을 연결해야 합니다.
  5. GitHub 편집기에서 콘텐츠에 필요한 변경을 합니다.
    • 편집기는 구문 강조와 미리 보기 기능을 제공합니다.
    • AsciiDoc 마크업을 사용해서 변경을 서식 지정할 수 있습니다.
    • ctrl-f를 사용해서 찾기/바꾸기 인터페이스를 열 수 있습니다.
  6. (선택) 변경을 미리 봅니다.
    • preview 탭을 사용해서 풍부한 서식으로 변경을 미리 봅니다.
    • show diff 옵션을 사용해서 변경된 섹션을 강조합니다. 제거된 섹션은 왼쪽 여백에 빨간 표시가 있고, 새 섹션은 왼쪽 여백에 초록 표시가 있어요.
  7. 편집이 끝나면 편집기 상단의 Commit changes… 버튼을 클릭합니다.
  8. 커밋 대화 상자에서:
    • 이메일 주소가 올바른지 확인합니다.
    • 변경을 설명하는 간결하지만 설명적인 커밋 메시지를 추가합니다.
    • 필요하면 선택적으로 더 긴 설명을 추가합니다.
    • 새 브랜치와 풀 리퀘스트를 만들도록 선택합니다.

제안된 변경을 포함하는 풀 리퀘스트가 생성됩니다.

풀 리퀘스트 개요 (Pull request overview)

PR을 만들 때:

  • 변경 사항은 저장소 유지 관리자의 검토를 위해 제출됩니다.
  • 검토자는 변경에 대해 코멘트하고 수정을 요청할 수 있습니다.
  • 변경을 검증하기 위해 자동화된 테스트가 실행될 수 있습니다.
  • 승인되면 변경이 메인 저장소에 병합될 수 있습니다.

풀 리퀘스트는 품질을 보장하고 통합 전에 변경을 논의할 방법을 제공합니다.

GitHub Docs에서 풀 리퀘스트가 어떻게 검토·승인되는지 알아보세요.

더 알아보기 (Learn more)