Skip to content

Commit

Permalink
Update DOCS_README with switch to GH Actions (#1049)
Browse files Browse the repository at this point in the history
* Update DOCS_README with switch to GH Actions

* update to repo makefile

Co-authored-by: billy rennekamp <[email protected]>
  • Loading branch information
dcwalk and okwme authored Nov 15, 2021
1 parent 64ac857 commit 73f91ec
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/DOCS_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ The documentation for Gaia is hosted at:

- https://hub.cosmos.network/

built from the files in this (`/docs`) directory for [master](https://github.com/cosmos/gaia/tree/main/docs)
built from the files in this (`/docs`) directory for [main](https://github.com/cosmos/gaia/tree/main/docs).

### How It Works

There is a CircleCI job listening for changes in the `/docs` directory, on both
the `master` and `develop` branches. Any updates to files in this directory
on those branches 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.
There is a [Github Action](https://github.com/cosmos/gaia/blob/main/.github/workflows/docs.yml)
listening for changes in the `/docs` directory, on the `main` branch.
Any updates to files in this directory on that branch will automatically
trigger a website deployment. Under the hood, `make build-docs` is run from the
[Makefile](https://github.com/cosmos/gaia/blob/main/Makefile) in this repo.

## README

Expand Down

0 comments on commit 73f91ec

Please sign in to comment.