GSoD_2021_Work_Summary.md

Wechaty

Improve the gRPC and OpenAPI ecosystem
Work Summary

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.
• #910: Adding Progressive Web Application support for the Docusaurus site.
• #1014: Adding Progressive Web Application support for the Jekyll blog.

Week 2 (May 25 - May 31, 2021)

In Polyglot/OpenAPI documentation in Wechaty docs website:

• #889: Adding Open Graph image metadata in the Docusaurus site of wechaty.js.org.
• #917: Improving Wechaty OpenAPI docs.
• #929: Adding a blog about both gRPC and OpenAPI.

Week 3 (June 1 - June 7, 2021)

In Polyglot/OpenAPI documentation in Wechaty docs website:

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

Week 4 (June 8 - June 14, 2021)

• wechaty/grpc#135 and wechaty/openapi#11: Generating and adding CHANGELOG.md file for both wechaty/wechaty-grpc and wechaty/openapi repository.
• wechaty/grpc#141 and wechaty/openapi#18: Removing the HISTORY section part from README for both wechaty/wechaty-grpc and wechaty/openapi repository.

Week 5 (June 15 - June 21, 2021)

• wechaty/grpc#139 and wechaty/openapi#14: Adding issue and pull request templates for wechaty/wechaty-grpc and wechaty/openapi repositories.
• wechaty/grpc#140 and wechaty/openapi#16: Adding CONTRIBUTING.md file for both wechaty/wechaty-grpc and wechaty/openapi repository.
• #1276: Improving contributing guidelines of wechaty.js.org.

Week 6 (June 22 - June 28, 2021)

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

Week 7 (June 29 - July 4, 2021)

• wechaty/grpc#141 and wechaty/openapi#18: 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.
• wechaty/grpc#141 and wechaty/openapi#18: Creating logo for wechaty/wechaty-grpc repository.

Week 8 (July 5 - July 11, 2021)

• wechaty/grpc#141 and wechaty/openapi#18: Refactoring and breaking the READMEs for both wechaty/wechaty-grpc and wechaty/openapi repository into sub-section like Usage, Installation, Contributing, and Resources, etc.
• wechaty/grpc#142 and wechaty/openapi#19: 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.
• #1383: Finalizing and submitting the project report.

Extra Work

• [GSoD 2021] Fixed typo in message.proto
• [GSoD 2021] Fixed favicon in Jekyll blog
• [GSoD 2021] Wrapped the string literals in a JSX container
• [GSoD 2021] Removed the console expression
• [GSoD 2021] Converted all Jekyll blog contributors images to webp