...
- Transition Caliper documentation to Hyperledger's standard template.
-
Implement versioning for documentation to track changes and updates effectively.
- Update content for accuracy and usability.
- Expand use case examples and tutorials.
- Add a dedicated troubleshooting section.
- Enhance technical descriptions with visual aids.
Milestones
Eval 1:
- Create a basic structure for the documentation
- Implement versioning for documentation to track changes and updates effectively.
- Migration of version
- GitHub action setup for deployment
- v0.2.0 and v0.5.0 (won't be included in final documentation deployment)
- Deployment Setup
Eval 2:
- Migration of v0.6.0
- Migration of vNext
- Conduct initial testing on Docker deployment
Eval 3:
- Ensuring the accuracy and currency of installation and configuration instructions.
- Expanding on use case examples and tutorials
- Troubleshooting section to address common issues and their resolutions.
Eval 4:
- Adding visual aids where necessary
- Conduct final system evaluations in a production-like environment using Docker
...
| Week | Task/Plan | Status |
|---|---|---|
| June 03 - June 23 | On-boarding/orientation sessions. Meet with the mentors, and discuss project implementation details, deliverables, and scope. Prepare the project plan. | Done |
| June 24 - July 7 | Implement the official documentation template into the Caliper repository fork. Explore various plugins such as GitHub links, version selectors, and analytics for template integration. Creation of an initial task list outlining the steps for migrating the current documentation content to the new template, ensuring seamless transition and functionality. | Done |
| July 8 - July 19 | Complete the basic structure, and migration of version v0.2.0 and v0.5.0 and addition of version selector. | Done |
| July 22 - July 26Review integration progress and Docker deployment strategy with mentors. | 1ST QUARTER MENTEE EVALUATION | |
| July 27 - August 18 | Complete the migration of all versions. Ensure accuracy and currency of installation and configuration instructions. | |
| August 19 - September 01 | Expand use case examples and tutorials. Also, add a troubleshooting section to address common issues and their resolutions. | |
| September 02 - September 06 | MIDTERM EVALUATIONS | |
| September 08 - September 22 | Add visual aids. Implement GitHub Actions for automated testing within Docker environments and continuous integration. | |
| September 23 - October 19 | Finalize all documentation, emphasizing Docker deployment strategies | |
| October 14 - October 18 | 3RD QUARTER MENTEE EVALUATION | |
| October 19 - November 10 | Timeline buffer. | |
| November 11 - November 29 | FINAL MENTEE EVALUATION |
...