Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

QA Testing of Iroha 2 Documentation #119

Open
54 tasks
AlexStroke opened this issue Aug 22, 2022 · 3 comments
Open
54 tasks

QA Testing of Iroha 2 Documentation #119

AlexStroke opened this issue Aug 22, 2022 · 3 comments
Assignees
@timofeevmd
Labels
M-epic Issues/PRs that depend on other items (e.g. tracking issues) M-meta Issues/PRs on the documentation itself (presentation, localization, navigation, etc.) M-QA Quality assurance on the documentation

Comments

@AlexStroke
Copy link
Contributor

AlexStroke commented Aug 22, 2022 •
edited
Loading

We need to perform QA testing on the Iroha 2 documentation to ensure the quality and accuracy of the content. https://hyperledger.github.io/iroha-2-docs/
Please go through each section and article, ensuring the content is accurate, clear, and easy to understand. Report any issues, inconsistencies, or errors that you find during the testing process. The following sections and article titles should be reviewed and tested:

Getting started

  • How Iroha works
  • Iroha 2 vs. Iroha 1
  • Build and Install
    • Quick Start with Docker
    • Install Iroha
    • Build Iroha Client
  • Receive support
  • Glossary

Tutorial

  • Introduction
  • Language-specific Guides
    • Bash
    • Python 3
    • Rust
    • Kotlin/Java
    • JavaScript

Blockchain

  • Overview
    • Transactions
    • Consensus
    • Data Model
    • Naming Conventions
  • Entities
    • Assets
    • Metadata
    • Events
    • Filters
    • Triggers
    • Queries
    • Permissions
    • World
  • Operations
    • Instructions
    • Expressions
    • Web Assembly

Configuration and Management

  • Configure Iroha
    • Configuration Types
    • Samples
    • Peer Configuration
    • Client Configuration
    • Genesis Block
    • Public Key Cryptography
    • Peer Management
    • Public and Private Blockchains

Troubleshooting

  • Overview
  • Installation
  • Configuration
  • Deployment
  • Integration

Advanced Mode

  • Iroha On Bare Metal
  • Hot Reload Iroha
  • Monitor Iroha Performance

API

  • Specification
  • Foreign Function Interfaces

Documenting Iroha

  • Code Snippets

Reports

  • CSD/RTGS linkages via on-chain scripting
@AlexStroke AlexStroke self-assigned this Aug 22, 2022
@AlexStroke AlexStroke changed the title Test "Getting started" and "Language-specific guides" sections of documentation Iroha 2 Test documentation of Iroha 2 Aug 22, 2022
@AlexStroke AlexStroke added the M-QA Quality assurance on the documentation label Aug 22, 2022
@AlexStroke AlexStroke changed the title Test documentation of Iroha 2 Testing documentation of Iroha 2 Aug 24, 2022
@AlexStroke
Copy link
Contributor Author

wait hyperledger/iroha-javascript#111

@AlexStroke AlexStroke changed the title Testing documentation of Iroha 2 Testing the Iroha 2 documentation Oct 13, 2022
@AlexStroke AlexStroke changed the title Testing the Iroha 2 documentation Testing Iroha 2 documentation Oct 13, 2022
@AlexStroke AlexStroke changed the title Testing Iroha 2 documentation Testing Iroha 2 documentation guide Oct 18, 2022
@6r1d
Copy link
Contributor

6r1d commented Oct 24, 2022

There is at least one issue in the Java part

@appetrosyan
Copy link
Contributor

Please consider converting to epic

@AlexStroke AlexStroke added the M-epic Issues/PRs that depend on other items (e.g. tracking issues) label Nov 7, 2022
@AlexStroke AlexStroke changed the title Testing Iroha 2 documentation guide QA Testing of Iroha 2 Documentation May 2, 2023
@AlexStroke AlexStroke removed their assignment May 2, 2023
@nxsaken nxsaken added the M-meta Issues/PRs on the documentation itself (presentation, localization, navigation, etc.) label May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@timofeevmd timofeevmd

Labels
M-epic Issues/PRs that depend on other items (e.g. tracking issues) M-meta Issues/PRs on the documentation itself (presentation, localization, navigation, etc.) M-QA Quality assurance on the documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@6r1d @appetrosyan @nxsaken @timofeevmd @AlexStroke