Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs migration from Vuepress to Docusaurus #2706

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
11 changes: 0 additions & 11 deletions docs/.vuepress/components/home.vue

This file was deleted.

167 changes: 0 additions & 167 deletions docs/.vuepress/config.js

This file was deleted.

91 changes: 0 additions & 91 deletions docs/.vuepress/styles/index.styl

This file was deleted.

16 changes: 5 additions & 11 deletions docs/DOCS_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ If you want to open a PR on Gaia to update the documentation, please follow the

## 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, `es` for Spanish, 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
- 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/master/docs/README.md). The layout defined in the `README.md` is used to build the homepage.
- For additional configuration options, please see [VuePress Internationalization](https://vuepress.vuejs.org/guide/i18n.html).
- Translations for documentation live in a `docs/translations/<locale>/` folder, where `<locale>` is the language code for a specific language. For example, `zh` for Chinese, `ko` for Korean, `es` for Spanish, etc.
- Each `docs/translations/<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/translations/<locale>/` folder
- Each `docs/translations/<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/master/docs/README.md). The layout defined in the `README.md` is used to build the homepage.

## Docs Build Workflow

Expand Down Expand Up @@ -86,19 +85,14 @@ Serve the app
npm run serve
```

then navigate to `localhost:8080` in your browser.
then navigate to `localhost:3000` in your browser.

To build documentation as a static website run `npm run build`. You will find the website in `.vuepress/dist` directory.
To build documentation as a static website run `npm run build`. You will find the website in `build` directory.

## Search

We are using [Algolia](https://www.algolia.com) to power full-text search. This uses a public API search-only key in the `config.js` as well as a [cosmos_network.json](https://github.com/algolia/docsearch-configs/blob/master/configs/cosmos_network.json) configuration file that we can update with PRs.

## Consistency

Because the build processes are identical (as is the information contained herein), this file should be kept in sync as
much as possible with its [counterpart in the Tendermint Core repo](https://github.com/tendermint/tendermint/blob/master/docs/DOCS_README.md).

### Update and Build the RPC docs

1. Execute the following command at the root directory to install the swagger-ui generate tool.
Expand Down
40 changes: 40 additions & 0 deletions docs/README copy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
parent:
order: false
layout: home
-->

# Cosmos Hub Documentation

Welcome to the documentation of the **Cosmos Hub application: `gaia`**.

## What is Gaia?

- [Intro to the `gaia` software](./getting-started/what-is-gaia.md)
- [Interacting with the `gaiad` binary](./hub-tutorials/gaiad.md)

## Join the Cosmos Hub Mainnet

- [Install the `gaia` application](./getting-started/installation.md)
- [Set up a full node and join the mainnet](./hub-tutorials/join-mainnet.md)
- [Upgrade to a validator node](./validators/validator-setup.md)

## Join the Cosmos Hub Public Testnet

- [Join the testnet](./hub-tutorials/join-testnet.md)

## Setup Your Own `gaia` Testnet

- [Setup your own `gaia` testnet](https://github.com/cosmos/testnets/tree/master/local/previous-local-testnets/v7-theta)

## Additional Resources

- [Validator Resources](./validators/README.md): Contains documentation for `gaia` validators.
- [Delegator Resources](./delegators/README.md): Contains documentation for delegators.
- [Other Resources](./resources/README.md): Contains documentation on `gaiad`, genesis file, service providers, ledger wallets, ...
- [Cosmos Hub Archives](./resources/archives.md): State archives of past iteration of the Cosmos Hub.

# Contribute

See [this file](./DOCS_README.md) for details of the build process and
considerations when making changes.
Loading