Skip to content
This repository was archived by the owner on Jun 29, 2022. It is now read-only.

Commit 6fb796b

Browse files
committed
RELEASE: Add steps to update the docs website entry
Signed-off-by: Suraj Deshmukh <suraj@kinvolk.io>
1 parent cbeba92 commit 6fb796b

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/RELEASING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,3 +140,33 @@ for generating new keys for signing.
140140

141141
Before signing a release with a new GPG key, it should be signed by other trusted
142142
keys and added to the [list of trusted keys in the repository](KEYS.md).
143+
144+
## Updating the docs website
145+
146+
Once the release is done. Make a pull request to the [docs repo](https://github.com/kinvolk/docs).
147+
Modify the Lokomotive
148+
[_index.md](https://github.com/kinvolk/docs/blob/master/docs/lokomotive/_index.md) file.
149+
150+
Modify the last entry pointing to `master` from `master` to a specific version (e.g. `"0.5.0"`):
151+
152+
```diff
153+
external_docs:
154+
- repo: https://github.com/kinvolk/lokomotive.git
155+
name: "0.5"
156+
- branch: "master"
157+
+ branch: "v0.5.0"
158+
dir: "docs"
159+
```
160+
161+
Now add a new entry at the top of the list with new version pointing to `master`:
162+
163+
```diff
164+
external_docs:
165+
+- repo: https://github.com/kinvolk/lokomotive.git
166+
+ name: "0.6"
167+
+ branch: "master"
168+
+ dir: "docs"
169+
- repo: https://github.com/kinvolk/lokomotive.git
170+
name: "0.5"
171+
branch: "v0.5.0"
172+
```

0 commit comments

Comments
 (0)