이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Apache Flink
- 테크니컬 라이터:
- haseeb1431
- 프로젝트 이름:
- Apache Flink용 Table API 및 SQL 문서 확장
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
'Extend the Table API & SQL Documentation'(테이블 API 및 SQL 문서 확장)에 관한 GSOD 신청을 제출합니다. 할머니도 쿼리를 작성할 수 있도록 API 문서를 작성할 예정입니다. 이미 구조가 있을 수 있지만 초보 사용자로서 구조를 살펴보고 필요한 경우 아이디어를 제안할 것입니다. 저는 멘토와 긴밀히 협력하여 멘토의 사고 과정을 이해하는 동시에 이전 업계 경험을 바탕으로 다양한 아이디어를 공유할 계획입니다.
현재 문서를 바탕으로 한 초기 생각은 다음과 같습니다.
개요 페이지에는 현재 많은 정보가 있지만 초보자와 고급 사용자 모두 빠르게 시작할 수 있도록 재검토하고 정렬해야 합니다. 제 생각은 가능한 다양한 트랙(a) 새 프로젝트를 시작한 다음 그 위에 쿼리를 실행, b) 기존 프로젝트에서 SQL 또는 Table API 쿼리 실행)을 시작하는 방법을 제공하는 것입니다.
또한 사용자가 한눈에 모든 가능성을 파악할 수 있도록 방문 페이지에 API 문서의 전체 맵을 제공해야 합니다. 현재 개요 페이지의 '다음으로 이동할 곳' 섹션을 개선한 버전입니다.
개념 페이지의 콘텐츠는 매우 좋지만 한 페이지에 너무 많은 내용이 포함되어 있으므로 이 페이지에는 하위 섹션이 거의 없습니다. 마찬가지로 다른 섹션인 Planners, Built-in functions, Connectors는 개요 페이지 또는 왼쪽 탐색 메뉴에 더 많이 표시되어야 합니다. 커넥터 페이지는 커넥터, 형식 등 더 많은 하위 섹션으로 나눌 수 있습니다. 시스템 (기본 제공) 함수는 한 페이지에 가능한 모든 메서드가 표시되어 있고 사용자가 항상 요약본으로 참고할 수 있으므로 괜찮아 보이지만, 관련 콘텐츠를 더 추가해도 됩니다.
3개월 기간은 여러 단계로 나뉩니다. 먼저 테이블 및 SQL API 문서의 사이트맵과 같은 구조를 만듭니다. 위에서 공유한 대로 하위 섹션을 도입하고 스토리라인을 소개할 예정입니다. 완료되면 고급 및 초급 수준의 사용자를 대상으로 검토할 수 있습니다. 반면에 의견을 기다리는 동안 계획자, 커넥터에 관해 작성할 수 있습니다. 의견을 보내주시면 API 문서를 재구성할 예정입니다. 다음으로 대기 중인 섹션의 작성을 완료하는 데 집중하겠습니다. 마지막으로, 시간이 허락하는 경우 샘플을 처음부터 살펴보고 FLINK-12639에 활용할 수 있는 엔드 투 엔드 프로젝트 구현을 보여주려고 합니다.
슬랙 (또는 다른 도구)에서 채팅하는 것 외에 2주 후에 1시간 동안 회의를 진행하는 것이 어떨까요? 프로젝트 진행 상황을 주별로 추적하는 데 도움이 되는 예상 기간이 포함된 초기 프로젝트 타임라인을 공유해 드리겠습니다.
마지막으로, 이 문서는 Flink API의 다양한 기능을 배울 때 모든 기본 세부정보를 추가하는 medium.com의 블로그와 유사합니다. 또한 기술 문서를 작성하는 대신 직접 구현을 통해 문서를 확인할 예정이므로 제가 특별한 후보가 될 수 있습니다. 이 프로젝트는 테이블 및 SQL API를 학습하는 동시에 오픈소스 문서에 기여할 수 있으므로 두 마리 토끼를 한 번에 잡을 수 있습니다.