Requirements for the Akash Documentation Structure
...
Requirements specification for Akash Documentation Structure. This specification focuses mostly on developer-oriented documentation.
The structure of the documentation and its content should help users create a clear mental model of how the network operates and what can be achieved by its use.
In-depth blockchain concepts.
The documentation serves an important role as a support for existing users of the Akash Network but is also extremely important as a gate to new users.
General customer profiles for each type of user who will be using the documentation are:
- First time users
- Frequent users
- Developers
We assume first time users are not familiar with Akash Network and cryptocurrencies. It's also assumed a limited knowledge of cloud/software technologies.
Frequent users are assumed to be looking for quick copy/paste examples and/or quick reference.
Developers are assumed to be looking for client documentation (Java, Go, ...) and/or general documentation.
- A working Akash wallet with AKT
The following table is a tabulation for the requirements.
| Req# | Requirement | Comments | Priority | Date Rvwd | SME Reviewed / Approved |
|---|---|---|---|---|---|
| R_01 | Documentation must be available in English | 1 |
The proposed structure is as follows:
- Getting Started
- Setting up the Environment
- Your First Deployment
- Concepts
- Akash Network
- Providers
- Deployments
- Bids & Leases
- DSEQ, GSEQ & OSEQ
- Validator Nodes
- SDL
- Network Features
- Deployments
- IP Leases
- Persistent Storage
- GPUs
- Architecture
- Overview
- Kubernetes & Containers
- Akash Node
- Akash Provider
- Guides
- Deploy using the CLI
- Deploying using Cloudmos
- Deploying using Terraform
- Developers
- This is the scope of the client libraries documentation
- Providers
- Setting up a Provider with Helm
- Setting up a Provider with Praetor
- Enabling monitoring
- Provider Auditing
- Enabling Persistent Storage
- Enabling IP Leasing
The first chapter (Getting Started) should allow users to have a running deployment in less than 5 minutes. It should also permanently setup the user's environment so that the development environment still works on a full restart. This can be achieved by changing the respective environment variables.
Each new chapter should reference the environment's requirements on an "Overview" page.