GSoD 2021 proposal to Improve the gRPC and OpenAPI ecosystem

About me

I considered myself a Polymath. I believe in rigorous and intuitive learning. Spend the majority of the time exploring different types of algorithms and contributing to open-source. My interest lies in the fields of Algorithms, Computational Science, and Distributed Computing.

Introduction

This is the project proposal for Improve the gRPC and OpenAPI ecosystem on which I will be working as a part of Google Season of Docs 2021. I have proposed my timeline to complete this work during a span of 9 weeks.

The user docs site is designed to assist end-users in using a product or service. The excellent user docs site is significant because it provides an avenue for users to learn how to use the software, its features, tips, tricks, and resolve common problems encountered when using the software. It also reduces support costs and is part of the corporate identity of the product. The excellent user docs site is a sign of the healthiness of the product, the developer team. Without a good user docs site, a user may not know how to do the above things effectively and efficiently. User docs site can play a pivotal role in ensuring a product’s success because excellent communication is and will always be at the heart of any business or development. Fantastic documentation takes that communication and puts it in a manageable framework that everyone can access for success.

Wechaty has two subsystems for providing the gRPC support: one is wechaty/wechaty-grpc and the other is wechaty/openapi. The related docs page is mainly at Polyglot/OpenAPI as well as other pages that have some OpenAPI associated docs.

However, the Wechaty user documentation for gRPC and OpenAPI is currently outdated and incomplete. Therefore, there should be an improvement in both code and documentation.

Project Goals

• Improving Polyglot/OpenAPI documentation in Wechaty docs website:

  • Improving Wechaty OpenAPI docs.
  • Adding a blog about both gRPC and OpenAPI.
  • Updating the History section and fetching all contents of the CHANGELOG.md file from wechaty/openapi repository using a script.
  • Adding learning resources section.

• Improving repository documentation for both wechaty/wechaty-grpc and wechaty/openapi:

  • Generating and adding CHANGELOG.md file for both wechaty/wechaty-grpc and wechaty/openapi repository.
  • Removing the HISTORY section part from README for both wechaty/wechaty-grpc and wechaty/openapi repository.
  • Adding issue and pull request templates for wechaty/wechaty-grpc and wechaty/openapi repositories.
  • Adding CONTRIBUTING.md file for both wechaty/wechaty-grpc and wechaty/openapi repository.
  • Improving contributing guidelines of wechaty.js.org.
  • Adding and organizing learning resources section about third parties library and frameworks like gRPC, gRPC-Gateway, and Protocol Buffers, etc in both wechaty/wechaty-grpc and wechaty/openapi repository.
  • Creating logo for wechaty/wechaty-grpc repository.
  • Refactoring and breaking the READMEs for both wechaty/wechaty-grpc and wechaty/openapi repository into sub-section like Usage, Installation, Contributing, and Resources, etc.

• Miscellaneous:

  • Adding Open Graph image metadata in the Docusaurus site of wechaty.js.org.
  • Adding Progressive Web Application support for the Docusaurus site and Jekyll blog.
  • Adding Swagger UI to Express Route by default in wechaty/openapi repository.
  • Format files that are necessary using Prettier for both wechaty/wechaty-grpc and wechaty/openapi repository.
  • Checking and fixing indentations, grammatical errors, typographical errors, and broken links across all the files, including previous and new documentations.

Project Timeline

Community Bonding (May 8 - May 17, 2021)

• Zoom meeting schedule agreed.
• Focus in the first two weeks before the start of the project will be on working through existing documentation and noting gaps areas.

Doc Development Phase

Week 1 (May 18 - May 24, 2021)

• Getting familiar with Wechaty projects.
• Going through all the existing contents and documentation based on gRPC and OpenAPI.
• Adding Progressive Web Application support for the Docusaurus site.
• Adding Progressive Web Application support for the Jekyll blog.

Week 2 (May 25 - May 31, 2021)

In Polyglot/OpenAPI documentation in Wechaty docs website:

• Adding Open Graph image metadata in the Docusaurus site of wechaty.js.org.
• Adding more details in the Getting Started section.
• Adding a blog about both gRPC and OpenAPI.

Week 3 (June 1 - June 7, 2021)

In Polyglot/OpenAPI documentation in Wechaty docs website:

• Updating the History section and fetching all contents of the CHANGELOG.md file from wechaty/openapi repository using a script.
• Adding learning resources section.

Week 4 (June 8 - June 14, 2021)

• Generating and adding CHANGELOG.md file for both wechaty/wechaty-grpc and wechaty/openapi repository.
• Removing the HISTORY section part from README for both wechaty/wechaty-grpc and wechaty/openapi repository.

Week 5 (June 15 - June 21, 2021)

• Adding issue and pull request templates for wechaty/wechaty-grpc and wechaty/openapi repositories.
• Adding CONTRIBUTING.md file for both wechaty/wechaty-grpc and wechaty/openapi repository.
• Improving contributing guidelines of wechaty.js.org.

Week 6 (June 22 - June 28, 2021)

• Adding Swagger UI to Express Route by default in wechaty/openapi repository.

Week 7 (June 29 - July 4, 2021)

• Adding and organizing learning resources section about third parties library and frameworks like gRPC, gRPC-Gateway, and Protocol Buffers, etc in both wechaty/wechaty-grpc and wechaty/openapi repository.
• Creating logo for wechaty/wechaty-grpc repository.

Week 8 (July 5 - July 11, 2021)

• Refactoring and breaking the READMEs for both wechaty/wechaty-grpc and wechaty/openapi repository into sub-section like Usage, Installation, Contributing, and Resources, etc.
• Format files that are necessary using Prettier for both wechaty/wechaty-grpc and wechaty/openapi repository.
• Checking and fixing indentations, grammatical errors, typographical errors, and broken links across all the files, including previous and new documentations.

Project Finalization Phase

Week 9 (July 12 - July 18, 2021)

• Finalizing the project deliverables and refactoring the code, if any, based on the feedback.
• Making the project report.
• Finalizing and submitting the project report.