mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2026-01-06 13:26:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify where doc site config settings must land (#7289)

Browse Source 
Since the doc site is built from the backport branches, the config changes for
a new major release also need to be replicated into the backport branch as well
as master. Update the release docs to mention that specifically, since I missed
it during the v0.35 release.
This commit is contained in:
M. J. Fromberger
2021-11-16 06:31:10 -08:00
committed by GitHub
parent d5df412b26
commit dbac109d01
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
RELEASES.md
View File

@@ -146,6 +146,8 @@ If there were no release candidates, begin by creating a backport branch, as des
- Add a new entry to `themeConfig.versions` in - Add a new entry to `themeConfig.versions` in
[`docs/.vuepress/config.js`](./docs/.vuepress/config.js) to include the [`docs/.vuepress/config.js`](./docs/.vuepress/config.js) to include the
release in the dropdown versions menu. release in the dropdown versions menu.
- Commit these changes to `master` and backport them into the backport
branch for this release.
## Minor release (point releases) ## Minor release (point releases)

6
docs/DOCS_README.md
View File

@@ -11,9 +11,9 @@ and other supported release branches.
There is a [GitHub Actions workflow](https://github.com/tendermint/docs/actions/workflows/deployment.yml) There is a [GitHub Actions workflow](https://github.com/tendermint/docs/actions/workflows/deployment.yml)
in the `tendermint/docs` repository that clones and builds the documentation in the `tendermint/docs` repository that clones and builds the documentation
site from the contents of this `docs` directory, for `master` and for each site from the contents of this `docs` directory, for `master` and for the
supported release branch. Under the hood, this workflow runs `make build-docs` backport branch of each supported release. Under the hood, this workflow runs
from the [Makefile](../Makefile#L214). `make build-docs` from the [Makefile](../Makefile#L214).
The list of supported versions are defined in [`config.js`](./.vuepress/config.js), The list of supported versions are defined in [`config.js`](./.vuepress/config.js),
which defines the UI menu on the documentation site, and also in which defines the UI menu on the documentation site, and also in