mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 04:07:57 +00:00
Jimmy Chu
39d5c357af
* wip Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com> * Added the rustdocs-release script Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com> * updated gitlab-ci script Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com> * Updated to set NIGHTLY to false by default Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com> * Added documentation Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com>
21 lines
822 B
Markdown
21 lines
822 B
Markdown
# Rustdocs Release Process
|
|
|
|
There is [a script in place](../.maintain/rustdocs-release.sh) to manage the deployment of Substrate rustdocs at
|
|
https://paritytech.github.io/substrate, which is pushing the rustdocs file in `gh-pages` branch of
|
|
https://github.com/paritytech/substrate.
|
|
|
|
The documentation at the top of the `rustdocs-release.sh` explains most of the mechanics of the script.
|
|
|
|
Manage the rustdocs deployment with one of the following commands.
|
|
|
|
```bash
|
|
# Deploy rustdocs of `monthly-2021-10` tag
|
|
.maintain/rustdocs-release.sh deploy monthly-2021-10
|
|
|
|
# In addition to the above, the `latest` symlink will point to this version of rustdocs
|
|
.maintain/rustdocs-release.sh deploy -l monthly-2021-10
|
|
|
|
# Remove the rustdocs of `monthly-2021-10` from `gh-pages`.
|
|
.maintain/rustdocs-release.sh remove monthly-2021-10
|
|
```
|