The goal of Season of Docs is to provide a framework for technical writers and open source projects to work together towards the common goal of improving an open source project's documentation. For technical writers who are new to open source, the program provides an opportunity to gain experience in contributing to open source projects. For technical writers who're already working in open source, the program provides a potentially new way of working together. Season of Docs also gives open source projects an opportunity to engage more of the technical writing community.
During the program, technical writers spend a few months working closely with an open source community. They bring their technical writing expertise to the project's documentation, and at the same time learn about the open source project and new technologies.
The open source projects work with the technical writers to improve the project's documentation and processes. Together they may choose to build a new documentation set, or redesign the existing docs, or improve and document the open source community's contribution procedures and onboarding experience.
Together, we raise public awareness of open source docs, of technical writing, and of how we can work together to the benefit of the global open source community.
Official site: https://developers.google.com/season-of-docs
Casbin is an authorization library that supports access control models like ACL, RBAC, ABAC for Golang, Java, C/C++, Node.js, Javascript, PHP, Laravel, Python, .NET (C#), Delphi, Rust, Ruby, Swift (Objective-C), Lua (OpenResty), Dart (Flutter) and Elixir.
Docs site: https://casbin.org/
Casdoor is a UI-first centralized authentication / Single-Sign-On (SSO) platform supporting OAuth 2.0, OIDC and SAML, integrated with Casbin RBAC and ABAC permission management.
Docs site: https://casdoor.org/
Tutorials are lessons that take the reader by the hand through a series of steps to complete running Casbin & Casdoor code. They are what our project needs in order to show a beginner that they can achieve something with it.
They are wholly learning-oriented, and specifically, they are oriented towards learning 'how' rather than learning 'what'.
Tutorials need to be useful for the beginner, easy to follow, meaningful, extremely robust, and kept up-to-date.
The Tutorial project should:
- Allow the user to learn by doing
- Get the user started
- Make sure that the tutorial works all the time
- Ensure the user sees results immediately
- Make the tutorial repeatable
- Focus on concrete steps, not abstract concepts
- Provide the minimum necessary explanation
- Focus only on the steps the user needs to take
- Work with the contributor team to update the documentation on the Casbin & Casdoor sites.
- This project is not an API reference, it can link to related pages for references.
- This project is not for experienced users
We have two committer candidates for mentoring our GSoD project, and we estimate that this work will take three months to complete. The creators of Casbin & Casdoor have committed to supporting the project.
Rui is mainly helping the technical writers to:
- get understand about the Documentation System: https://docusaurus.io/
- join the Casbin community as soon as possible and understand all the tools our community is using.
- get answered all the questions about Casbin, Casdoor and the community.
As of today, Casbin site receives 3,000 page views (PVs) per day and Casdoor site receives 300 PVs per day. The average visit duration is 2 min, the bounce rate is 75%.
We will track the above metrics (page views, visit duration, and bounce rate) monthly after the documentation is published. We will also track the number of user getting started questions, starting quarterly after the documentation is published.
We would consider the project successful if, after the publication of the new documentation:
- The tutorials page views increase by 50%
- The visit duration on tutorials increases by 50% (>3 minutes)
- The bounce rate of tutorials decreases by 25% (<50%)
| Budget item | Amount | Running Total | Notes/justifications |
|---|---|---|---|
| Technical writer audit, update, test, and publish new documentation for Casbin docs site | 4000.00 | 4000.00 | |
| Technical writer audit, update, test, and publish new documentation for Casdoor docs site | 4000.00 | 8000.00 | |
| Volunteer stipends | 500 | 9500.00 | 3 volunteer stipends x 500 each |
| TOTAL | 9500.00 |
Ref: proposal template
Our technical writers have been announced: Yash Pandey and Iris Luo
- Casbin docs site ($4k), Yash Pandey
- Casdoor docs site ($4k), Iris Luo
The excess of the budget will be subsidized by the community.
If you are a Technical Writer and you are interested to contribute to Casbin community for Google Season of Docs 2022, Please send your proposal (by following the template of writing the statement of interest from Google) to our mail at: [email protected] , and then introduce yourself after joining our Casbin Gitter.im channel for connecting.