이 가이드에 기여 - Amazon EKS

기존 기여자에 대한 요약 로컬 편집 환경 설정 github.dev 웹 기반 편집기 사용 단일 페이지 편집 페이지의 ID 보기 및 설정 새 페이지 생성 이미지 삽입 Vale을 사용하여 스타일 확인 로컬 미리 보기 빌드 AsciiDoc 치트 시트

이 가이드에 기여

누구나 모범 사례 가이드에 기여할 수 있습니다. EKS 모범 사례 가이드는 GitHub에서 AsciiDoc 형식으로 작성되었습니다.

기존 기여자에 대한 요약

VS Codebpg-docs.code-workspace를 사용하여를 열어 AsciiDoc 확장을 자동으로 설치합니다.
- Visual Studio Marketplace의 AsciiDoc 확장에 대해 자세히 알아보세요.
AWS Docs 웹 사이트의 소스 파일은에 저장됩니다. latest/bpg
구문은 마크다운과 매우 유사합니다.
- AsciiDoctor 문서의 구문 참조를 검토합니다.
문서 플랫폼은 만 배포합니다latest/bpg/images. 각 가이드 섹션에는이 디렉터리로 돌아가는 심볼 링크가 있습니다. 예를 들어는를 latest/bpg/networking/images 가리킵니다latest/bpg/images.

로컬 편집 환경 설정

가이드를 자주 편집하려는 경우 로컬 편집 환경을 설정합니다.

리포지토리 포크 및 복제

git, github및 텍스트 편집기에 익숙해야 합니다. git 및 시작하기에 대한 자세한 내용은 GitHub 문서의 GitHub 계정 시작하기를 github참조하세요. GitHub

GitHub의 EKS 모범 사례 가이드를 확인하세요.
프로젝트 리포지토리의 포크를 생성합니다. GitHub 문서에서 리포지토리를 포크하는 방법을 알아봅니다.
프로젝트 리포지토리의 포크를 복제합니다. 포크 리포지토리를 복제하는 방법을 알아봅니다.

VS Code Workspace 열기

AWS는 Microsoft의 Visual Studio 코드를 사용하여 가이드를 편집할 것을 권장합니다. VS 코드에 대한 자세한 내용은 Visual Studio 코드 설명서의 Visual Studio 코드 다운로드 및 Visual Studio 코드 시작하기를 참조하세요.

VS Code를 엽니다.
복제된 리포지토리에서 bpg-docs.code-workspace 파일을 엽니다.
이 워크스페이스를 처음 여는 경우 프롬프트를 수락하여 AsciiDoc 확장을 설치합니다. 이 확장은 AsciiDoc 파일의 구문을 확인하고 실시간 미리 보기를 생성합니다.
latest/bpg 디렉터리를 찾습니다. 이 디렉터리에는 AWS 설명서 사이트에 배포되는 소스 파일이 들어 있습니다. 소스 파일은 "보안" 또는 "네트워킹"과 같은 가이드 섹션별로 구성됩니다.

파일 편집

편집기에서 파일을 엽니다.
- AsciiDoc 구문을 보고 제목, 링크 및 목록을 생성하는 방법을 알아봅니다.
- 마크다운 구문을 사용하여 텍스트, 목록 및 제목의 형식을 지정할 수 있습니다. 마크다운 구문을 사용하여 링크를 생성할 수 없습니다.
페이지의 실시간 미리 보기를 엽니다.
- 먼저 ctrl-k 또는 cmd-k (키보드에 따라 다름)를 누릅니다. 둘째,를 누릅니다v. 그러면 분할 보기에서 미리 보기가 열립니다.

AWS는 기능 브랜치를 사용하여 변경 사항을 구성하는 것을 권장합니다. git을 사용하여 브랜치를 생성하는 방법을 알아봅니다.

풀 요청 제출

GitHub 웹 사이트 또는 GitHub cli에서 풀 요청을 생성할 수 있습니다.

GitHub 웹 사이트를 사용하여 포크에서 풀 요청을 생성하는 방법을 알아봅니다.

GitHub cli를 사용하여 풀 요청을 생성하는 방법을 알아봅니다.

github.dev 웹 기반 편집기 사용

github.dev 웹 기반 편집기는 VS 코드를 기반으로 합니다. 이는 설정 없이 여러 파일을 편집하고 콘텐츠를 미리 볼 수 있는 좋은 방법입니다.

AsciiDoc 확장을 지원합니다. GUI를 사용하여 git 작업을 수행할 수 있습니다. 웹 기반 편집기에는 명령을 실행하기 위한 쉘 또는 터미널이 없습니다.

GitHub 계정이 있어야 합니다. 필요한 경우 로그인하라는 메시지가 표시됩니다.

🚀 GitHub 웹 기반 편집기를 시작합니다.

단일 페이지 편집

GitHub를 사용하여 개별 페이지를 빠르게 업데이트할 수 있습니다. 각 페이지에는 하단에 “📝GitHub에서이 페이지 편집” 링크가 있습니다.

이 가이드에서 편집하려는 페이지로 이동합니다.
하단의 "GitHub에서이 페이지 편집" 링크를 클릭합니다.
GitHub 파일 뷰어의 오른쪽 상단에 있는 연필 편집 아이콘을 클릭하거나를 누릅니다. e
파일 편집
"변경 사항 커밋..." 버튼을 사용하여 변경 사항을 제출합니다. 이 버튼은 GitHub 풀 요청을 생성합니다. 가이드 유지 관리자는이 풀 요청을 검토합니다. 검토자가 풀 요청을 승인하거나 변경을 요청합니다.

페이지의 ID 보기 및 설정

이 페이지에서는 페이지 ID를 보고 설정하는 방법을 설명합니다.

페이지 ID는 설명서 사이트의 각 페이지를 식별하는 고유한 문자열입니다. 특정 페이지에 있을 때 브라우저의 주소 표시줄에서 페이지 ID를 볼 수 있습니다. 페이지 ID는 URL, 파일 이름 및 상호 참조 링크를 생성하는 데 사용됩니다.

예를 들어이 페이지를 보는 경우 브라우저 주소 표시줄의 URL은 다음과 비슷합니다.

https://docs.aws.amazon.com/view-set-page-id.html

URL의 마지막 부분(view-set-page-id)은 페이지 ID입니다.

페이지 ID 설정

새 페이지를 생성할 때 소스 파일에서 페이지 ID를 설정해야 합니다. 페이지 ID는 페이지 내용을 설명하는 간결하고 하이픈으로 묶인 문자열이어야 합니다.

텍스트 편집기에서 새 페이지의 소스 파일을 엽니다.
파일 상단에 다음 줄을 추가합니다. 첫 번째 제목 위에 있어야 합니다.
```
[#my-new-page]
```
를 새 페이지의 페이지 IDmy-new-page로 바꿉니다.
파일을 저장합니다.

참고

페이지 IDs 전체 설명서 사이트에서 고유해야 합니다. 기존 페이지 ID를 사용하려고 하면 빌드 오류가 발생합니다.

새 페이지 생성

새 페이지를 생성하고 가이드 목차를 업데이트하는 방법을 알아봅니다.

페이지 메타데이터 생성

페이지 제목과 페이지 단축 제목을 결정합니다. 페이지 짧은 제목은 선택 사항이지만 페이지 제목이 몇 단어 이상인 경우 권장됩니다.
페이지의 ID를 결정합니다. 이는 EKS 모범 사례 안내서 내에서 고유해야 합니다. 규칙은 소문자를 모두 사용하고 단어를 로 구분하는 것입니다-.
필요한 경우 폴더에 새 asciidoc 파일을 생성하고 파일에 다음 텍스트를 추가합니다.

[."topic"] [#<page-id>] = <page-title> :info_titleabbrev: <page-short-title>

예:

[."topic"] [#scalability] = EKS Scalability 모범 사례: info_titleabbrev: Scalability

목차에 추가

목차에서 상위 페이지의 파일을 엽니다. 새 최상위 가이드 섹션의 경우 상위 파일은 입니다book.adoc.
상위 파일 하단에서 다음 명령을 업데이트하고 삽입합니다.

포함::<new-filename>[leveloffset=+1]

예를 들어,

포함::dataplane.adoc[leveloffset=+1]

이미지 삽입

편집하려는 페이지의 이미지 접두사를 찾습니다. 파일 제목의 :imagesdir: 속성을 검토합니다. 예를 들어, `:imagesdir: images/reliability/
다음과 같이 이미지를이 경로에 배치합니다. latest/bpg/images/reliability
이미지에 적합한 alt-text를 결정합니다. 이미지에 대한 간단한 상위 수준 설명을 작성합니다. 예를 들어, "가용 영역이 3개인 VPC의 다이어그램"은 적절한 alt-text입니다.
다음 예제를 alt-text 및 이미지 파일 이름으로 업데이트합니다. 원하는 위치에를 삽입합니다.

image::<image-filename>[<image-alt-text>]

예:

image::eks-data-plane-connectivity.jpeg[네트워크 다이어그램]

Vale을 사용하여 스타일 확인

Vale CLI를 설치합니다.
vale sync 실행
Visual Studio Marketplace에서 Vale 확장을 설치합니다.
VS Code를 다시 시작하고 AsciiDoc 파일을 엽니다.
VS 코드는 문제가 있는 텍스트를 강조 표시합니다. VS Code 문서에서 오류 및 경고를 사용하는 방법을 알아봅니다.

로컬 미리 보기 빌드

brew Linux 또는 MacOS에서를 사용하여 asciidoctor 도구 설치
- AsciiDoctor 문서에 asciidoctor cli를 설치하는 방법을 알아봅니다. AsciiDoctor
- 양조 패키지 관리자를 설치하는 방법을 알아봅니다.
터미널을 열고 로 이동합니다. latest/bpg/
asciidoctor book.adoc 실행
- 구문 경고 및 오류 검토
book.html 출력 파일을 엽니다.
- MacOS에서는를 실행open book.html하여 기본 브라우저에서 미리 보기를 열 수 있습니다.

AsciiDoc 치트 시트

기본 형식 지정


*bold text*
_italic text_
`monospace text`

헤더


= Document Title (Header 1)
== Header 2
=== Header 3
==== Header 4
===== Header 5
====== Header 6

Lists

정렬되지 않은 목록:


- Item 1
- Item 2
-- Subitem 2.1
-- Subitem 2.2
- Item 3

정렬된 목록:


. First item
. Second item
.. Subitem 2.1
.. Subitem 2.2
. Third item

Links


External link:  https://example.com[Link text]
Internal link: <<page-id>>
Internal link: xref:page-id[Link text]

이미지


image::image-file.jpg[Alt text]

코드 블록


 [source,python]
 ----
 def hello_world():
     print("Hello, World!")
 ----

표

기본 테이블을 빌드하는 방법을 알아봅니다.


[cols="1,1"]
|===
|Cell in column 1, row 1
|Cell in column 2, row 1

|Cell in column 1, row 2
|Cell in column 2, row 2

|Cell in column 1, row 3
|Cell in column 2, row 3
|===

주의 문구


NOTE: This is a note admonition.

WARNING: This is a warning admonition.

TIP: This is a tip admonition.

IMPORTANT: This is an important admonition.

CAUTION: This is a caution admonition.

미리 보기:

참고

참고에 관한 주의 문구입니다.

포함 내용


 include::filename.adoc[]

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

호스트 자격 증명

쿠키 기본 설정 선택

쿠키 기본 설정 사용자 지정

필수

성능

기능

광고

쿠키 기본 설정을 저장할 수 없음