GitBook: [docs-2.0] 38 pages modified

README.md

@@ -1,8 +1,8 @@
 # Introduction
 
-Welcome to the documentation and user guides for [Akash](https://github.com/ovrclk/akash), the decentralized cloud platform. Akash -- "open space, sky" in ancient Sanskrit -- is the world’s first distributed peer-to-peer open cloud computing marketplace; our aim is to materialize the vision of an open cloud that’s as boundless and free as the sky.
+Welcome to the support documentation and user guides for [Akash](https://github.com/ovrclk/akash), the decentralized cloud platform. Akash -- "open space, sky" in ancient Sanskrit -- is the world’s first distributed peer-to-peer open cloud computing marketplace; our aim is to materialize the vision of an open cloud that’s as boundless and free as the sky.
 
-For details about what [Akash](https://github.com/ovrclk/akash) can do and what makes it tick, see [Features and Design](design/).
+For details about what [Akash](https://github.com/ovrclk/akash) can do and what makes it tick, see [Features and Design](decentralized-cloud/design.md).
 
 ## Guides
 
@@ -15,18 +15,18 @@ For details about what [Akash](https://github.com/ovrclk/akash) can do and what
 * [Run an Akash Node](guides/node/)
   * [RPC Service](guides/node/rpc-service.md)
   * [API Service](guides/node/api-service.md)
-  * [Run a Validator](guides/node/validator.md)
-* [Become a Provider](guides/provider.md)
-* [Common Commands](guides/general-commands.md)
-* [Upgrade to Akashnet-2](guides/upgrade-mainnet.md)
-* [Using the Deploy Tool](guides/deploy-tool.md)
-* [Multi-Tiered Deployment](guides/multi-tier-app.md)
-* [Software Upgrade: Akashnet-2-upgrade-1](guides/akashnet-2-software-upgrade.md)
-* [Akashnet-2 IBC Connections](guides/akashnet-relayer.md)
+  * [Run a Validator](validators/validator.md)
+* [Become a Provider](providers/provider.md)
+* [Common Commands](decentralized-cloud/general-commands.md)
+* [Upgrade to Akashnet-2]()
+* [Using the Deploy Tool]()
+* [Multi-Tiered Deployment](guides-1/multi-tier-app.md)
+* [Software Upgrade: Akashnet-2-upgrade-1]()
+* [Akashnet-2 IBC Connections](guides-1/akashnet-relayer.md)
 
 ## Documentation
 
-* [Stack Definition Language](documentation/sdl.md)
+* [Stack Definition Language](decentralized-cloud/sdl.md)
 * [Akash CLI reference](documentation/akash.md)
 * [FAQ](documentation/faq.md)
 

SUMMARY.md

@@ -1,12 +1,17 @@
 # Table of contents
 
 * [Introduction](README.md)
-* [Features and Design](design/README.md)
-  * [Marketplace](design/marketplace.md)
-  * [Escrow](design/escrow.md)
-  * [mTLS](design/mtls.md)
 
-## Guides
+## Decentralized Cloud
+
+* [Marketplace](decentralized-cloud/marketplace.md)
+* [Escrow](decentralized-cloud/escrow.md)
+* [mTLS](decentralized-cloud/mtls.md)
+* [Stack Definition Language](decentralized-cloud/sdl.md)
+* [Command Line Interface](decentralized-cloud/general-commands.md)
+* [Features](decentralized-cloud/design.md)
+
+## Getting Started <a id="guides"></a>
 
 * [Overview](guides/guides.md)
 * [Choosing a Network](guides/version.md)
@@ -17,18 +22,26 @@
 * [Run an Akash Node](guides/node/README.md)
   * [RPC Service](guides/node/rpc-service.md)
   * [API Service](guides/node/api-service.md)
-  * [Run a Validator](guides/node/validator.md)
-* [Become a Provider](guides/provider.md)
-* [Common Commands](guides/general-commands.md)
-* [Upgrade to Akashnet-2](guides/upgrade-mainnet.md)
-* [Using the Deploy Tool](guides/deploy-tool.md)
-* [Multi-Tiered Deployment](guides/multi-tier-app.md)
-* [Software Upgrade: Akashnet-2-upgrade-1](guides/akashnet-2-software-upgrade.md)
-* [Inter-Blockchain \(IBC\) Connections](guides/akashnet-relayer.md)
 
 ## Documentation
 
-* [Stack Definition Language](documentation/sdl.md)
 * [Akash CLI reference](documentation/akash.md)
-* [FAQ](documentation/faq.md)
+* [Frequently Asked Questions](documentation/faq.md)
+
+## Providers
+
+* [Becoming a Provider](providers/provider.md)
+
+## Validators
+
+* [Running a Validator](validators/validator.md)
+
+## Guides <a id="guides-1"></a>
+
+* [Awesome Akash](guides-1/awesome-akash.md)
+* [Multi-Tiered Deployment](guides-1/multi-tier-app.md)
+* [Helium Validator](guides-1/helium-validator.md)
+* [PostgreSQL restore/backup](guides-1/postgresql-restore-backup.md)
+* [Ruby on Rails with Sia and Auth0](guides-1/ruby-on-rails-with-sia-and-auth0.md)
+* [Inter-Blockchain \(IBC\) Connections](guides-1/akashnet-relayer.md)
 

design/README.md → decentralized-cloud/design.md

@@ -1,4 +1,4 @@
-# Features and Design
+# Features
 
 ## Features and Design
 
@@ -9,28 +9,13 @@ The [Akash](https://github.com/ovrclk/akash) DeCloud is comprised of two main co
 
 The **Network** is built with [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) - it is a [tendermint](https://github.com/tendermint/tendermint)-based blockchain application.
 
-The **Platform** is a set of [cloud management services](./#provider-services) that leverage [Kubernetes](https://kubernetes.io) to run workloads.
+The **Platform** is a set of [cloud management services](design.md#provider-services) that leverage [Kubernetes](https://kubernetes.io) to run workloads.
 
 The software to run the **Network**, the **Platform**, and the command-line client used to interact with them are all currently distributed in the `akash` application.
 
 ### Workflow - Life of a Deployment
 
-Deploying applications onto [Akash](https://github.com/ovrclk/akash) involves two types of users:
 
-1. The **Tenant**: the entity that deploys the application.
-2. The **Provider**: the entity that hosts the application.
-
-Given that there are live providers on the network, the lifecycle of a typical application deployment is as follows:
-
-1. The tenant describes their desired deployment in \[SDL\], called a [deployment](marketplace.md#deployment).
-2. The tenant submits that definition to the blockchain.
-3. Their submission generates an [order](marketplace.md#order) on the marketplace.
-4. Providers that would like to fulfill that order [bid](marketplace.md#bid) on it.
-5. After some period of time, a winning [bid](marketplace.md#bid) for the [order](marketplace.md#order) is chosen, and a [lease](marketplace.md#lease) is created.
-6. Once a [lease](marketplace.md#lease) has been created, the tenant submits a [manifest](../documentation/sdl.md) to the provider.
-7. The provider executes workloads as instructed by the [manifest](../documentation/sdl.md).
-8. The workload is running - if it is a web application it can be visited, etc...
-9. The provider or tenant eventually closes the [lease](marketplace.md#lease), shutting down the workload.
 
 ## Features
 
@@ -44,7 +29,7 @@ Tenants define workloads requirements, as well as regional and pricing parameter
 
 ### Networking
 
-Networking - allowing connectivity to and between workloads - can be configured via the [SDL](../documentation/sdl.md) for a deployment.
+Networking - allowing connectivity to and between workloads - can be configured via the [SDL](sdl.md) for a deployment.
 
 By default, workloads in a deployment group are isolated - nothing else is allowed to connect to them. This restriction can be relaxed by enabling
 

guides/general-commands.md → decentralized-cloud/general-commands.md

@@ -1,4 +1,36 @@
-# Common Commands
+# Command Line Interface
+
+## The Akash CLI
+
+The Akash command line utility 
+
+```text
+  -h, --help   help for akash
+```
+
+## Akash Commands
+
+* [akash ](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_.md)     - 
+* [akash ](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_.md)     - 
+* [akash add-genesis-account](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_add-genesis-account.md)     - Add a genesis account to genesis.json
+* [akash collect-gentxs](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_collect-gentxs.md)     - Collect genesis txs and output a genesis.json file
+* [akash debug](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_debug.md)     - Tool for helping with debugging your application
+* [akash deploy](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_deploy.md)     - Akash deploy tool commands
+* [akash events](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_events.md)     - Prints out akash events in real time
+* [akash export](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_export.md)     - Export state to JSON
+* [akash gentx](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_gentx.md)     - Generate a genesis tx carrying a self delegation
+* [akash init](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_init.md)     - Initialize private validator, p2p, genesis, and application configuration files
+* [akash keys](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_keys.md)     - Manage your application's keys
+* [akash migrate](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_migrate.md)     - Migrate genesis to a specified target version
+* [akash provider](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_provider.md)     - Akash provider commands
+* [akash query](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_query.md)     - Querying subcommands
+* [akash start](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_start.md)     - Run the full node
+* [akash status](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_status.md)     - Query remote node for status
+* [akash tendermint](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_tendermint.md)     - Tendermint subcommands
+* [akash tx](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_tx.md)     - Transactions subcommands
+* [akash unsafe-reset-all](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_unsafe-reset-all.md)     - Resets the blockchain database, removes address book files, and resets data/priv\_validator\_state.json to the genesis state
+* [akash validate-genesis](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_validate-genesis.md)     - validates the genesis file at the default location or at the location passed as an arg
+* [akash version](https://github.com/ovrclk/docs/tree/ed6bc0143968bc6e4e92c26c5dad6427f048bc2d/cli/akash_version.md)     - Print the application binary version information
 
 ## Send Tokens
 

design/marketplace.md → decentralized-cloud/marketplace.md

@@ -1,23 +1,42 @@
 # Marketplace
 
+The Akash Marketplace is an auction for compute resources. It is the mechanism by which users acquire resources on the Akash Platform.
+
 * [Overview](marketplace.md#overview)
 * [Payments](marketplace.md#payments)
 * [On-Chain Parameters](marketplace.md#on-chain-parameters)
 * [Transactions](marketplace.md#transactions)
 * [Models](marketplace.md#models)
 
-The Akash Marketplace is an auction for compute resources. It is the mechanism by which users acquire resources on the Akash Platform.
-
 ## Overview
 
 The Akash Marketplace revolves around [Deployments](marketplace.md#deployment), which fully describe the resources that a tenant is requesting from the network. [Deployments](marketplace.md#deployment) contain [Groups](marketplace.md#group), which is a grouping of resources that are meant to be leased together from a single provider.
 
+Deploying applications onto [Akash](https://github.com/ovrclk/akash) involves two types of users:
+
+1. The **Tenant**: the entity that deploys the application.
+2. The **Provider**: the entity that hosts the application.
+
 The general workflow is:
 
 1. A tenant creates orders.
 2. Providers bid on orders.
 3. Tenants choose winning bids and create leases.
 
+### Lifecycle of a Deployment
+
+Given that there are live providers on the network, the lifecycle of a typical application deployment is as follows:
+
+1. The tenant describes their desired deployment in \[SDL\], called a [deployment](marketplace.md#deployment).
+2. The tenant submits that definition to the blockchain.
+3. Their submission generates an [order](marketplace.md#order) on the marketplace.
+4. Providers that would like to fulfill that order [bid](marketplace.md#bid) on it.
+5. After some period of time, a winning [bid](marketplace.md#bid) for the [order](marketplace.md#order) is chosen, and a [lease](marketplace.md#lease) is created.
+6. Once a [lease](marketplace.md#lease) has been created, the tenant submits a [manifest](sdl.md) to the provider.
+7. The provider executes workloads as instructed by the [manifest](sdl.md).
+8. The workload is running - if it is a web application it can be visited, etc...
+9. The provider or tenant eventually closes the [lease](marketplace.md#lease), shutting down the workload.
+
 ## Payments
 
 Leases are paid from deployment owner \(tenant\) to the provider through a deposit & withdraw mechanism.

documentation/faq.md

@@ -1,4 +1,4 @@
-# FAQ
+# Frequently Asked Questions
 
 If there is something you'd like to see in here that isn't already, please reach out \(_link to channels_\) to one of the mods and we'll get it added!