From 987959c541fa25be01aef1f47a89a48d8b30caa6 Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Wed, 20 Jul 2022 14:04:55 +0200 Subject: [PATCH] docs: improve docs (#12647) * docs: improve docs * set default version --- .github/workflows/deploy-docs.yml | 3 ++- docs/.vuepress/config.js | 23 +++++++---------------- docs/DOCS_README.md | 19 ++----------------- docs/ko/README.md | 3 --- docs/ru/README.md | 3 --- docs/versions | 2 +- docs/zh/README.md | 3 --- 7 files changed, 12 insertions(+), 44 deletions(-) delete mode 100755 docs/ko/README.md delete mode 100755 docs/ru/README.md delete mode 100644 docs/zh/README.md diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index a1473e7ff21..a1622c8539f 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -5,6 +5,7 @@ on: push: branches: - main + - "release/**" paths: - "docs/**" - "x/**/*.md" @@ -15,7 +16,7 @@ permissions: jobs: build-and-deploy: permissions: - contents: write # for JamesIves/github-pages-deploy-action to push changes in repo + contents: write # for JamesIves/github-pages-deploy-action to push changes in repo runs-on: ubuntu-latest container: image: tendermintdev/docker-website-deployment diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 26454e7e7d2..429f7346dc4 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -5,15 +5,6 @@ module.exports = { "/": { lang: "en-US" }, - ko: { - lang: "ko" - }, - ru: { - lang: "ru" - }, - zh: { - lang: "zh-CN" - } }, base: process.env.VUEPRESS_BASE || "/", head: [ @@ -29,6 +20,7 @@ module.exports = { themeConfig: { repo: "cosmos/cosmos-sdk", docsRepo: "cosmos/cosmos-sdk", + docsBranch: "main", docsDir: "docs", editLinks: true, label: "sdk", @@ -146,16 +138,11 @@ module.exports = { url: "https://www.youtube.com/c/CosmosProject" } ], - smallprint: - "This website is maintained by Tendermint Inc. The contents and opinions of this website are those of Tendermint Inc.", + 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.", links: [ { title: "Documentation", children: [ - { - title: "Cosmos SDK", - url: "https://docs.cosmos.network" - }, { title: "Cosmos Hub", url: "https://hub.cosmos.network" @@ -163,7 +150,11 @@ module.exports = { { title: "Tendermint Core", url: "https://docs.tendermint.com" - } + }, + { + title: "IBC-Go", + url: "https://ibc.cosmos.network" + }, ] }, { diff --git a/docs/DOCS_README.md b/docs/DOCS_README.md index 644292b81ff..7afa49ad857 100644 --- a/docs/DOCS_README.md +++ b/docs/DOCS_README.md @@ -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). -## Internationalization - -* Translations for documentation live in a `docs//` folder, where `` is the language code for a specific language. For example, `zh` for Chinese, `ko` for Korean, `ru` for Russian, etc. -* Each `docs//` 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//` folder: - * `docs/basics/` - * `docs/building-modules/` - * `docs/core/` - * `docs/ibc/` - * `docs/intro/` - * `docs/migrations/` - * `docs/run-node/` -* Each `docs//` 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 -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 -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 diff --git a/docs/ko/README.md b/docs/ko/README.md deleted file mode 100755 index 387ae45dd49..00000000000 --- a/docs/ko/README.md +++ /dev/null @@ -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). diff --git a/docs/ru/README.md b/docs/ru/README.md deleted file mode 100755 index fa21b98e847..00000000000 --- a/docs/ru/README.md +++ /dev/null @@ -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). diff --git a/docs/versions b/docs/versions index 6fdd15d21b8..dece42efc0a 100644 --- a/docs/versions +++ b/docs/versions @@ -1,5 +1,5 @@ release/v0.44.x v0.44 release/v0.45.x v0.45 -release/v0.46.x v0.46 main master main main +release/v0.46.x v0.46 diff --git a/docs/zh/README.md b/docs/zh/README.md deleted file mode 100644 index 095fa073d03..00000000000 --- a/docs/zh/README.md +++ /dev/null @@ -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).