docs: improve docs (#12647)

* docs: improve docs

* set default version
This commit is contained in:
Julien Robert 2022-07-20 14:04:55 +02:00 committed by GitHub
parent 64674ba9e5
commit 987959c541
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 12 additions and 44 deletions

View File

@ -5,6 +5,7 @@ on:
push: push:
branches: branches:
- main - main
- "release/**"
paths: paths:
- "docs/**" - "docs/**"
- "x/**/*.md" - "x/**/*.md"

View File

@ -5,15 +5,6 @@ module.exports = {
"/": { "/": {
lang: "en-US" lang: "en-US"
}, },
ko: {
lang: "ko"
},
ru: {
lang: "ru"
},
zh: {
lang: "zh-CN"
}
}, },
base: process.env.VUEPRESS_BASE || "/", base: process.env.VUEPRESS_BASE || "/",
head: [ head: [
@ -29,6 +20,7 @@ module.exports = {
themeConfig: { themeConfig: {
repo: "cosmos/cosmos-sdk", repo: "cosmos/cosmos-sdk",
docsRepo: "cosmos/cosmos-sdk", docsRepo: "cosmos/cosmos-sdk",
docsBranch: "main",
docsDir: "docs", docsDir: "docs",
editLinks: true, editLinks: true,
label: "sdk", label: "sdk",
@ -146,16 +138,11 @@ module.exports = {
url: "https://www.youtube.com/c/CosmosProject" url: "https://www.youtube.com/c/CosmosProject"
} }
], ],
smallprint: smallprint: "The development of the Cosmos SDK is led primarily by [Interchain Core Teams](https://interchain.io/ecosystem). Funding for this development comes primarily from the Interchain Foundation, a Swiss non-profit.",
"This website is maintained by Tendermint Inc. The contents and opinions of this website are those of Tendermint Inc.",
links: [ links: [
{ {
title: "Documentation", title: "Documentation",
children: [ children: [
{
title: "Cosmos SDK",
url: "https://docs.cosmos.network"
},
{ {
title: "Cosmos Hub", title: "Cosmos Hub",
url: "https://hub.cosmos.network" url: "https://hub.cosmos.network"
@ -163,7 +150,11 @@ module.exports = {
{ {
title: "Tendermint Core", title: "Tendermint Core",
url: "https://docs.tendermint.com" url: "https://docs.tendermint.com"
} },
{
title: "IBC-Go",
url: "https://ibc.cosmos.network"
},
] ]
}, },
{ {

View File

@ -2,28 +2,13 @@
If you want to open a PR in Cosmos SDK to update the documentation, please follow the guidelines in [`CONTRIBUTING.md`](https://github.com/cosmos/cosmos-sdk/tree/main/CONTRIBUTING.md#updating-documentation). If you want to open a PR in Cosmos SDK to update the documentation, please follow the guidelines in [`CONTRIBUTING.md`](https://github.com/cosmos/cosmos-sdk/tree/main/CONTRIBUTING.md#updating-documentation).
## Internationalization
* Translations for documentation live in a `docs/<locale>/` folder, where `<locale>` is the language code for a specific language. For example, `zh` for Chinese, `ko` for Korean, `ru` for Russian, etc.
* Each `docs/<locale>/` folder must follow the same folder structure within `docs/`, but only content in the following folders needs to be translated and included in the respective `docs/<locale>/` folder:
* `docs/basics/`
* `docs/building-modules/`
* `docs/core/`
* `docs/ibc/`
* `docs/intro/`
* `docs/migrations/`
* `docs/run-node/`
* Each `docs/<locale>/` folder must also have a `README.md` that includes a translated version of both the layout and content within the root-level [`README.md`](https://github.com/cosmos/cosmos-sdk/tree/main/docs/README.md). The layout defined in the `README.md` is used to build the homepage.
* Always translate content living on `main` unless you are revising documentation for a specific release. Translated documentation like the root-level documentation is semantically versioned.
* For additional configuration options, please see [VuePress Internationalization](https://vuepress.vuejs.org/guide/i18n.html).
## Docs Build Workflow ## Docs Build Workflow
The documentation for Cosmos SDK is hosted at https://docs.cosmos.network/ and built from the files in the `/docs` directory. The documentation for Cosmos SDK is hosted at https://docs.cosmos.network and built from the files in the `/docs` directory.
### How It Works ### How It Works
There is a CircleCI job listening for changes in the `/docs` directory for the `main` branch and each supported version tag (`v0.39` and `v0.42`). Any updates to files in the `/docs` directory will automatically trigger a website deployment. Under the hood, the private website repository has a `make build-docs` target consumed by a CircleCI job within that repository. There is a GitHub Action listening for changes in the `/docs` directory for the `main` branch and each supported version branch (e.g. `release/v0.46.x`). Any updates to files in the `/docs` directory will automatically trigger a website deployment. Under the hood, the private website repository has a `make build-docs` target consumed by a Github Action within that repository.
## README ## README

View File

@ -1,3 +0,0 @@
# Cosmos SDK Documentation (Korean)
A Korean translation of the Cosmos SDK documentation is not available for this version. If you would like to help with translating, please see [Internationalization](https://github.com/cosmos/cosmos-sdk/blob/main/docs/DOCS_README.md#internationalization).

View File

@ -1,3 +0,0 @@
# Cosmos SDK Documentation (Russian)
A Russian translation of the Cosmos SDK documentation is not available for this version. If you would like to help with translating, please see [Internationalization](https://github.com/cosmos/cosmos-sdk/blob/main/docs/DOCS_README.md#internationalization).

View File

@ -1,5 +1,5 @@
release/v0.44.x v0.44 release/v0.44.x v0.44
release/v0.45.x v0.45 release/v0.45.x v0.45
release/v0.46.x v0.46
main master main master
main main main main
release/v0.46.x v0.46

View File

@ -1,3 +0,0 @@
# Cosmos SDK Documentation (Chinese)
A Chinese translation of the Cosmos SDK documentation is not available for this version. If you would like to help with translating, please see [Internationalization](https://github.com/cosmos/cosmos-sdk/blob/main/docs/DOCS_README.md#internationalization).