Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Recommendations: PLEASE ADD YOuR IDEAS

  • Create user guides for the 3 different Persons
  • Create templates for consistent community user guides
  • Make User Guides available to community when needed
  • Malcolm:

    Image Added






    Hyperledger User Guide Template

    [Project Name] User Guide

    Table of Contents:
    1. Introduction
    2. Installation
       2.1 System Requirements
       2.2 Downloading the Project
       2.3 Dependencies and Prerequisites
       2.4 Installation Steps
    3. Configuration
       3.1 Network Configuration
       3.2 Node Configuration
       3.3 Certificate Authority Setup
    4. Usage
       4.1 Network Startup
       4.2 Chaincode Deployment
       4.3 Interacting with the Network
       4.4 Querying and Updating the Ledger
    5. Advanced Features
       5.1 Smart Contract Development
       5.2 Private Data
       5.3 Endorsement Policies
    6. Troubleshooting
       6.1 Common Issues and Solutions
       6.2 Debugging Techniques
    7. Best Practices
       7.1 Security Considerations
       7.2 Performance Optimization
    8. Glossary
    9. Resources and References
    10. Appendix




Personas

Where will they reside

...

      1. Sign in to your GitHub account or create a new one at https://github.com.

      2. Once you're logged in, click on the "+" sign at the top right corner of the GitHub homepage and select "New repository."

      3. On the "Create a new repository" page, provide a name for your repository. Choose a descriptive and meaningful name that reflects the purpose of your lab.

      4. Optionally, you can provide a description for your repository to give others an idea of what it's about.

      5. Select the repository's visibility. You can choose between making it public, private, or internal. Public repositories are visible to everyone, private repositories are only accessible to you and collaborators you invite, while internal repositories are visible to members of your organization.

      6. Initialize the repository with a README file by checking the "Initialize this repository with a README" box. This README file will serve as the landing page for your lab repository, providing important information and instructions for others.

      7. Choose an appropriate license for your lab repository. Click on the "Add a license" dropdown and select a license that suits your needs. If you're not sure which license to choose, you can research and select one later.

      8. If desired, you can add a .gitignore file to specify which files should be ignored by Git when tracking changes. This file helps avoid committing and pushing unnecessary or sensitive files to the repository.

      9. Click on the "Create repository" button to create the repository with the provided settings.

      10. After creating the repository, you can clone it to your local machine using Git. Open a terminal or command prompt, navigate to the directory where you want to clone the repository, and run the following command:

bash
git clone <repository_url>

Replace <repository_url> with the URL of your lab repository. You can find the repository URL on the repository's main page.

...

2. For Quick Video PICTORY
Put RESULTS in https://app.pictory.ai/textinput

View file
nameMaintainerGuideforLA.mp4dummyfile.txt
pageUser Guides
spaceTF
height250

3. For Quick Presentation: Gamma

Put RESULTS in https://gamma.app/docs/Setting-up-a-GitHub-Repository-for-Your-Lab-swido9n4vp032df

View file
nameSet up Github for Lab.pptx
pageUser Guides
spaceTF
height250