Project Plan - Hyperledger Caliper documentation platform update

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:

• Create a basic structure for the documentation
• Implement versioning for documentation to track changes and updates effectively.
• Migration of version 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

Timeline