Abstract
The goal of this project is to enhance the Hyperledger Caliper documentation by aligning it with user needs and community feedback. This includes transitioning to a standardized template used across Hyperledger projects to improve accessibility, consistency, and comprehensiveness. The focus will be on refining content to cover all aspects of Caliper thoroughly, from installation and configuration to usage and troubleshooting, ensuring it remains current and accurate. These improvements aim to boost usability, adoption, and overall user satisfaction.
Mentor and Mentee
Mentor: Attila Klenik
Timezone: CET
Mentee: Pratiksha Sankhe
Timezone: IST
Project repo:
https://github.com/hyperledger/caliper
Deliverables
- 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:
- Implement versioning for documentation to track changes and updates effectively.
- Migration of version
- GitHub action setup for deployment
Eval 2:
- Conduct initial testing on Docker deployment
Eval 3:
Eval 4:
- Conduct final system evaluations in a production-like environment using Docker
Timeline
Week | Task/Plan | Status |
---|---|---|
June 03 - June 23 | On boarding/orientation sessions. Meet with the mentors, discuss project implementation details, deliverables and scope. Prepare the project plan. | |
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. | |
July 8 - July 19 | ||
July 22 - July 26 | Review integration progress and Docker deployment strategy with mentors. 1ST QUARTER MENTEE EVALUATION | |
July 27 - August 18 | ||
August 19 - September 01 | ||
September 02 - September 06 | MIDTERM EVALUATIONS | |
September 08 - September 22 | 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 |