Project Plan - Bevel Documentation redesign
- Mushir Ayub Lokhandwala
- Jagpreet Singh Sasan
Owned by Mushir Ayub Lokhandwala
Abstract
A documentation serves best when understood and designed based on user needs. Although Hyperledger Bevel current documentation is comprehensive and robust, it still requires improvement and can be much more effective and usefulĀ if designed based on user and community needs. The project scopes to structure the existing documentation of Hyperledger Bevel and redesign it from the perspective of user personas and their deployment needs. It would equally benefit product users and developers, and increase usability and adoption.Ā
Mentors
| Name | Time zone | Discord ID | Email ID |
|---|---|---|---|
| Sownak Roy | UK | sownak | sownak.roy@accenture.com |
| Suvajit Sarkar | IST | ssark#4224 | suvajit.sarkar@accenture.com |
| Jagpreet Singh Sasan | IST | axetacular | jagpreet.singh.sasan@accenture.com |
Mentee
| Name | Time zone | Discord ID | Email ID |
|---|---|---|---|
| Mushir Lokhandwala | IST | shinchan#7232 | mushirlokhandwala9@gmail.com |
Communication channel:Ā Discord+ Github
Project repo: https://github.com/hyperledger/bevel
Deliverables
- The newly created docs to be hosted on ReadTheDocs
- All images hosted on the agreed platform and images exported to the docs
- All PR review comments to be incorporated
Merged PR's
- TBD
Final Project Presentation:
- TBD
Milestones
Eval 1:
- The base structure of new theme based docs to be created and shown on ReadTheDocs
Eval 2:
- TBD
Eval 3:
- TBD
Eval 4:
- TBD
Timeline
| Dates | Tasks/Plan | Status |
|---|---|---|
| Jun 12 - Jun 26 | Mentee intro with the mentor. | Done |
| Jun 27 - Jul 10 | Understanding the current state of documentation and ReadTheDocs configuration/hosting | Done |
| Aug 17 - Aug 24 | Setup initial base structure on ReadTheDocs using the Sphinx Material Theme, light/dark theme suppport and required code preview & chart plugins | Done |
Aug 25 - Sept 04 | Drafting the documentation contents of each top level documentation modules (Get Started, How to... etc) | Done |
| Sept 5 - Sep 14 | Complete Get Started section and host it on ReadTheDocs (same for other sections in subsequent bi-weekly tasks) | Ongoing |
| Sep 15 - Sep 21 | Complete How to section and host | Ongoing |
| Sep 22 - Sep 28 | Complete Concepts section and host | Ongoing |
| Sep 29 - Oct 5 | Complete Tutorials section and hostĀ | Ongoing |
Oct 6 - Oct 16 | Complete Reference section and host | Ongoing |
Oct 17 - Oct 30 (Oct 20 eval) | Complete Contribution section and host | Ongoing |
| Oct 31 - Nov 6 | Create PR and incorporate review comments - Phase 1 | |
| Nov 7 - Nov 30 (Nov 30 eval) | Create PR and incorporate review comments - Phase 2 |
Methodology
- TBD
- TBD
- TBD