이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Cloud Native Computing Foundation (CNCF)
- 기술 문서 작성자:
- 시암 선다 K
- 프로젝트 이름:
- 더 많은 Kubectl 예시
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
이 프로젝트의 목적은 기존 kubectl 요약본 및 참조 문서를 개선하는 것입니다.
이 프로젝트의 궁극적인 목표는 다음과 같습니다. • 더 많은 양질의 kubectl 예시를 만듭니다. • kubectl 요약본에 kubectl 예시 추가하기 • 최대한 유용하도록 kubectl 문서를 리팩터링했습니다.
목표 I - kubectl 예시:
Kubernetes 사용자가 가장 원하는 예시의 맥락을 파악하고 문서화하기 위해 CLI 특별 관심분야 그룹과 긴밀하게 협력할 예정입니다. 여기에는 요약본의 기존 kubectl 명령어를 개선하는 것부터 요약본에 새 명령어를 추가하는 것까지 다양합니다.
목표 II - 문서의 유용성 향상:
문서의 유용성을 높이기 위해 다음 작업을 할 수 있습니다.
• 초보자가 겪는 어려움을 제거합니다. • 논리적 흐름의 연속성을 보장하기 위해 특정 순서로 kubectl 명령어를 재정렬합니다.
명령어 / 사용자 사례 설명을 개선하여 초보자의 어려움을 없애세요. 단순해 보이지만 초보자가 학습을 계속할지 중단할지에 큰 영향을 미칠 수 있습니다. 예를 들어 kubectl을 통해 Kubernetes를 시작했을 때는 포드와 배포 간의 차이점을 몰랐습니다. 처음에는 nodejs로 작성된 백엔드 서비스를 배포했습니다. 몇 시간 후 포드를 중단하고 싶었기 때문에 포드를 삭제하려고 했지만 포드의 자가 복구 특성으로 인해 포드가 다시 생성되었습니다. 무슨 일이 일어나고 있는지 잘 모르겠고 왜 삭제되지 않고 다시 생성되는지 궁금했습니다. 웹에서 몇 가지를 찾아본 결과, pod를 삭제하는 것이 배포를 삭제하는 것과는 다르다는 것을 알게 되었습니다. 숙련된 사용자에게는 간단해 보일 수 있지만 이러한 모호성을 제거하는 명확한 설명이 좋은 문서와 훌륭한 문서를 구분하는 요소입니다.
논리적 흐름의 연속성을 보장하기 위해 kubectl 명령어를 특정 순서로 재정렬합니다. 스토리텔링을 강하게 믿는 저와 같은 사람이라면 터미널 명령어 목록이 있는 문서 시트에 스토리텔링 요소를 가져오는 방법을 궁금해할 것입니다. 가능합니다. 우리가 배우는 모든 것에는 항상 논리적인 흐름이 있습니다. 시작점과 끝점이 있는 것이죠. 명령줄 도구인 kubectl에는 학습 곡선이 있습니다. 사실 kubectl의 학습 곡선은 Kubernetes 자체의 학습 곡선과 일치합니다. 웹 UI를 사용하는 사용자를 제외하고 거의 모든 사용자가 kubectl을 통해 Kubernetes 여정을 시작하며, kubectl의 학습 곡선은 Kubernetes의 학습 곡선과 밀접하게 연결되어 있으므로 이러한 명령어의 순서를 변경하고 스토리텔링 요소를 도입하는 것만으로도 문서를 크게 개선할 수 있습니다. 예를 들어 수평형 포드 자동 확장과 같은 기능은 실제 예시와 그림으로 리소스를 설명한 후에 설명할 수 있습니다.
목표 III - Docs 사용성 개선:
최근 Kubernetes 웹사이트를 Docsy Hugo로 이전한 것은 멋진 일이며 문서 관점에서 큰 변화입니다. 이전은 완료되었지만 문서 공간에는 아직 개선의 여지가 많습니다.
다음과 같은 변경사항을 제안합니다.
• 왼쪽 창이 기본 문서에서 현재 활성 상태인 섹션으로 자동 스크롤 - 현재, 예정된, 이전 섹션을 추적하는 데 도움이 될 수 있습니다. • 클립보드에 복사 - 일부 명령어는 길 수 있습니다. 이러한 종류의 명령어를 사용할 때는 복사 기능이 유용할 수 있습니다. • doc 파일의 콘텐츠 형식 - 이전 후 일부 페이지의 콘텐츠 형식이 올바르게 지정되지 않습니다. 예: kubectl 개요의 리소스 유형 섹션 이로 인해 사용자 환경이 저하됩니다.
이러한 변경사항은 kubernetes 웹사이트의 사용자 환경을 개선하고 사용자 생산성을 높일 수 있습니다.