From ffa7d82186f2b5ababc08df2f17dbcdb7d093a74 Mon Sep 17 00:00:00 2001 From: Greg Osuri Date: Wed, 16 Oct 2019 23:19:10 -0700 Subject: [PATCH] update --- .gitbook.yml | 3 +- README.md | 11 +-- SUMMARY.md | 14 +++ ...igh-level-overview-of-the-akash-network.md | 2 - ...es-how-to-deploy-a-riot-chat-client-and.md | 23 ----- usage-documentation/command-line-usage.md | 2 - usage/README.md | 91 ------------------- usage/{cli.md => cli/README.md} | 0 8 files changed, 20 insertions(+), 126 deletions(-) create mode 100644 SUMMARY.md delete mode 100644 getting-started/akash-intro-high-level-overview-of-the-akash-network.md delete mode 100644 getting-started/deployment-tutorial-a-tutorial-to-deploy-on-akash.-it-showcases-how-to-deploy-a-riot-chat-client-and.md delete mode 100644 usage-documentation/command-line-usage.md delete mode 100644 usage/README.md rename usage/{cli.md => cli/README.md} (100%) diff --git a/.gitbook.yml b/.gitbook.yml index c3904f82..6bf7d4cc 100644 --- a/.gitbook.yml +++ b/.gitbook.yml @@ -1,4 +1,5 @@ structure: - summary: README.md + readme: README.md + summary: SUMMARY.md redirects: help: https://akash.network/chat diff --git a/README.md b/README.md index 71474b4c..67c9b1fb 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,15 @@ -# Table of contents - -* [Introduction](README.md) +# Akash Network Documentation ## Getting Started -* [Akash Intro: High-level overview of the Akash Network](getting-started/akash-intro-high-level-overview-of-the-akash-network.md) -* [Deployment tutorial: A tutorial to deploy on Akash. It showcases how to deploy a riot chat client an](getting-started/deployment-tutorial-a-tutorial-to-deploy-on-akash.-it-showcases-how-to-deploy-a-riot-chat-client-and.md) +* [Akash Intro](overview/README.md) High-level overview of the Akash Network +* [Deployment tutorial](guides/deploy/README.md) A tutorial to deploy on Akash. It showcases how to deploy a riot chat client an ## Usage Documentation -* [Command Line Usage](usage-documentation/command-line-usage.md) +* [Command Line Usage](usage/cli/README.md) ## Whitepapers * [Akash Network Theorotical Paper](whitepapers/akash-network-theorotical-paper.md) * [AKT: Token Economics Whitepaper](whitepapers/akt-token-economics-whitepaper.md) - diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 00000000..ff5fc91c --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,14 @@ +# Summary + +## Overview +* [Akash Intro](overview/README.md) + +## Guides +* [Deployment](guides/deploy/README.md) + +## Usage +* [Command Line Usage](usage/cli/README.md) + +## Whitepapers +* [Akash Network Theorotical Paper](whitepapers/akash-network-theorotical-paper.md) +* [AKT: Token Economics Whitepaper](whitepapers/akt-token-economics-whitepaper.md) diff --git a/getting-started/akash-intro-high-level-overview-of-the-akash-network.md b/getting-started/akash-intro-high-level-overview-of-the-akash-network.md deleted file mode 100644 index c1b9b7fb..00000000 --- a/getting-started/akash-intro-high-level-overview-of-the-akash-network.md +++ /dev/null @@ -1,2 +0,0 @@ -# Akash Intro: High-level overview of the Akash Network - diff --git a/getting-started/deployment-tutorial-a-tutorial-to-deploy-on-akash.-it-showcases-how-to-deploy-a-riot-chat-client-and.md b/getting-started/deployment-tutorial-a-tutorial-to-deploy-on-akash.-it-showcases-how-to-deploy-a-riot-chat-client-and.md deleted file mode 100644 index d2a88079..00000000 --- a/getting-started/deployment-tutorial-a-tutorial-to-deploy-on-akash.-it-showcases-how-to-deploy-a-riot-chat-client-and.md +++ /dev/null @@ -1,23 +0,0 @@ -# Deployment tutorial: A tutorial to deploy on Akash. It showcases how to deploy a riot chat client an - -## Getting Super Powers - -Becoming a super hero is a fairly straight forward process: - -``` -$ give me super-powers -``` - -{% hint style="info" %} - Super-powers are granted randomly so please submit an issue if you're not happy with yours. -{% endhint %} - -Once you're strong enough, save the world: - -``` -// Ain't no code for that yet, sorry -echo 'You got to trust me on this, I saved the world' -``` - - - diff --git a/usage-documentation/command-line-usage.md b/usage-documentation/command-line-usage.md deleted file mode 100644 index 639a552b..00000000 --- a/usage-documentation/command-line-usage.md +++ /dev/null @@ -1,2 +0,0 @@ -# Command Line Usage - diff --git a/usage/README.md b/usage/README.md deleted file mode 100644 index 0424088a..00000000 --- a/usage/README.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: Akash Documentation - -toc_footers: - - Sign Up for Akash TestNet - -
- -includes: - - usage - - testnet - -search: true ---- - -# Introduction - -The Akash Network is a decentralized protocol for provisioning, scaling, and securing cloud workloads. Using Akash, companies (Providers) make their spare server capacity available for containerized deployments by any developer (Tenants). Tenants benefit from access to a a low-cost, decentralized, geographically distributed cloud infrastructure platform whose conventions are very similar to any other cloud provider. Providers benefit by monetizing the idle compute capacity in their on-prem and colocated datacenters. - -The Network contains two major functional elements: - -* **Marketplace**: A blockchain-based system that allocates capacity on provider servers to tenants wishing to deploy to them, and transfers payments from tenant to provider in the native Akash (AKSH) token. -* **Deployment**: A Kubernetes-based system that provisions pods on provider servers and deploys/orchestrates Tenant containers within them. - -The permission-less marketplace provides a censorship-resistant procurement mechanism for highly scalable and secure container based deployments for base resources which are compute, memory, bandwidth, and storage. - -### See a mistake? Open a pull request - -[https://github.com/ovrclk/docs](https://github.com/ovrclk/docs) - -# Installation - -The Akash Suite is composed of a full node `akashd` and the client `akash`. The full node (`akashd`) is the (tendermint-based) blockchain node that implements the decentralized exchange. `akash` is the client used to access the exchange and network in general. - -## MacOS - -> Install Homebrew - -```shell -$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" -``` - -> Install `akash` client and `akashd` daemon using homebrew - -```shell -$ brew install ovrclk/tap/akash -``` - -The simplest way to install is by using [homebrew](https://brew.sh). Install `akash` client by running `brew install ovrclk/tap/akash`. Once installed, verify the installation by running `akash version`. - -Alternatively, you can manually download the [binaries](https://github.com/ovrclk/akash/releases/download/v0.3.6/akash_0.3.6_darwin_amd64.tar.gz) from the [releases page](https://github.com/ovrclk/akash/releases). The latest release is `0.3.6` as of writing of this document, please make sure to check the releases page for the latest version. The final step is to make sure that the akash binary is available on the `PATH`.[This page](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix) contains instructions for setting the PATH on MacOS. - -## Linux - -Download the [linux archive](https://github.com/ovrclk/akash/releases/download/v0.3.6/akash_0.3.6_linux_amd64.tar.gz) from the [release page](https://github.com/ovrclk/akash/releases). The latest release is `0.3.6` as of writing of this document, please make sure to check the releases page for the latest version. - -The final step is to make sure that the terraform binary is available on the `PATH`.[This page](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix) contains instructions for setting the PATH on Linux. - -## Windows - -Download the [windows archive](https://github.com/ovrclk/akash/releases/download/v0.3.6/akash_0.3.6_windows_amd64.tar.gz) from the [release page](https://github.com/ovrclk/akash/releases). The latest release is `0.3.6` as of writing of this document, please make sure to check the releases page for the latest version. - -The final step is to make sure that the akash binary is available on the `PATH`.[This page](https://stackoverflow.com/questions/1618280/where-can-i-set-path-to-make-exe-on-windows) contains instructions for setting the PATH on Windows. - -## Others (From Source) - -> Installing akash suite from source - -```shell -$ go get -d github.com/ovrclk/akash -$ cd $GOPATH/src/github.com/ovrclk/akash -$ make deps-install -$ make install -``` - -Akash is developed and tested with [golang 1.8+](https://golang.org/). Building requires a working [golang](https://golang.org/) installation, a properly set `GOPATH`, and `$GOPATH/bin` present in `$PATH`. - -Additional requirements are: - -* [glide](https://github.com/Masterminds/glide): Golang library management. - -For development environments, requirements include: - -* [protocol buffers](https://developers.google.com/protocol-buffers/): Protobuf compiler. - -Most golang libraries will be packaged in the local `vendor/` directory via [glide](https://github.com/Masterminds/glide), however the following packages will - be installed globally with their binaries placed in `$GOPATH/bin` by `make devdeps-install`: - -* [gogoprotobuf](https://github.com/gogo/protobuf): Golang protobuf compiler plugin. -* [mockery](https://github.com/vektra/mockery): Mock generator. - -Once you have the dependencies properly setup, download and build `akash` and `akashd` using `make install` diff --git a/usage/cli.md b/usage/cli/README.md similarity index 100% rename from usage/cli.md rename to usage/cli/README.md