certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Quick fix to docs to not show staging website (#4983) 

Remove mention of develop and staging environment.
This commit is contained in:
Marko 2019-09-03 14:27:23 +02:00 committed by Alessio Treglia
parent 13e5e18d77
commit 847d3be896
1 changed files with 12 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/DOCS_README.md
View File

@ -4,19 +4,16 @@ If you want to open a PR on the Cosmos SDK to update the documentation, please f
## Docs Build Workflow ## Docs Build Workflow
The documentation for the Cosmos SDK is hosted at: The documentation for the Cosmos SDK is hosted at https://cosmos.network/docs/
- https://cosmos.network/docs/ and
- https://cosmos-staging.interblock.io/docs/
built from the files in this (`/docs`) directory for built from the files in this (`/docs`) directory for
[master](https://github.com/cosmos/cosmos-sdk/tree/master/docs). [master](https://github.com/cosmos/cosmos-sdk/tree/master/docs).
### How It Works ### How It Works
There is a CircleCI job listening for changes in the `/docs` directory, on both There is a CircleCI job listening for changes in the `/docs` directory, on
the `master` and `develop` branches. Any updates to files in this directory the `master` branch. Any updates to files in this directory
on those branches will automatically trigger a website deployment. Under the hood, on that branch will automatically trigger a website deployment. Under the hood,
the private website repository has a `make build-docs` target consumed by a CircleCI job in that repo. the private website repository has a `make build-docs` target consumed by a CircleCI job in that repo.
## README ## README
@ -111,14 +108,14 @@ much as possible with its [counterpart in the Tendermint Core repo](https://gith
### Update and Build the RPC docs ### Update and Build the RPC docs
1. Execute the following command at the root directory to install the swagger-ui generate tool. 1. Execute the following command at the root directory to install the swagger-ui generate tool.
```bash ```bash
make tools make tools
``` ```
2. Edit API docs 2. Edit API docs
1. Directly Edit API docs manually: `client/lcd/swagger-ui/swagger.yaml`. 1. Directly Edit API docs manually: `client/lcd/swagger-ui/swagger.yaml`.
2. Edit API docs within the [Swagger Editor](https://editor.swagger.io/). Please refer to this [document](https://swagger.io/docs/specification/2-0/basic-structure/) for the correct structure in `.yaml`. 2. Edit API docs within the [Swagger Editor](https://editor.swagger.io/). Please refer to this [document](https://swagger.io/docs/specification/2-0/basic-structure/) for the correct structure in `.yaml`.
3. Download `swagger.yaml` and replace the old `swagger.yaml` under fold `client/lcd/swagger-ui`. 3. Download `swagger.yaml` and replace the old `swagger.yaml` under fold `client/lcd/swagger-ui`.
4. Compile gaiacli 4. Compile gaiacli
```bash ```bash
make install make install
``` ```