이 페이지에는 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로 작성된 백엔드 서비스를 배포했습니다. 몇 시간 후에 포드를 내려놓고 싶었기 때문에 포드를 삭제하려고 했지만 포드의 자가 복구 특성으로 인해 포드가 다시 생성되었습니다. 무슨 일이 벌어지고 있는지 당황했고 왜 다시 만들어지지 않고 삭제되지 않는지 궁금했습니다. 웹에서 몇 번 검색해 본 결과 포드 삭제가 배포를 삭제하는 것과 같지 않다는 것을 알게 되었습니다. 숙련된 사람에게는 이 방법이 간단해 보일 수 있지만, 이러한 모호함을 없앨 수 있는 명확한 설명을 통해 좋은 문서와 훌륭한 문서를 구분할 수 있습니다.
논리적 흐름의 연속성을 보장하기 위해 kubectl 명령어를 특정 순서로 재정렬하기 저처럼 스토리텔링을 굳게 믿는 사람이라면 아마도 스토리텔링 요소를 터미널 명령어 목록이 있는 문서 시트로 어떻게 가져오는지 궁금하실 겁니다. 우리가 배우는 것이 항상 논리적으로 흐름이 있습니다. 원하는 경우 시작과 끝점입니다. 명령줄 도구로서의 kubectl은 분명히 학습 곡선이 있습니다. 실제로 학습 곡선은 Kubernetes 자체의 학습 곡선과 일치합니다. 거의 모든 사람이 kubectl을 통해 Kubernetes 여정을 시작하며 (웹 UI 사용자는 제외) 학습 곡선이 Kubernetes 학습 곡선과 밀접하게 연결되어 있기 때문에, 명령어의 순서를 변경하고 여기에 스토리텔링 요소를 도입하는 것만으로도 문서를 훨씬 개선할 수 있습니다. 예를 들어 실제 예시와 삽화로 리소스를 설명하면 수평형 포드 자동 확장과 같은 기능을 설명할 수 있습니다.
목표 3 - 문서 사용성 개선:
최근 Kubernetes 웹사이트를 Docsy Hugo로 마이그레이션한 것은 멋진 일이며 문서 관점에서 엄청난 전환입니다. 이전에 성공했지만 문서 공간에 많은 개선의 여지가 있습니다.
제가 추천하는 몇 가지 변화를 소개합니다.
• 왼쪽 창은 기본 문서에서 현재 활성화된 섹션으로 자동 스크롤 - 현재 섹션, 향후 섹션, 이전 섹션을 추적하는 데 도움이 됩니다. • 클립보드에 복사 - 일부 명령어가 길어질 수 있습니다. 이러한 종류의 명령어를 사용할 때는 복사 기능이 유용할 수 있습니다. • 문서 파일의 콘텐츠 형식 지정: 이전 후 일부 페이지의 콘텐츠가 적절한 형식(예: kubectl 개요의 리소스 유형 섹션)으로 지정되지 않았습니다. 이 경우 사용자 환경이 저하됩니다.
Kubernetes 웹사이트의 사용자 경험을 개선하고 사용자 생산성을 높일 수 있는 변경사항입니다.