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

Commit ecabd1b

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

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/RELEASING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,3 +191,23 @@ for generating new keys for signing.
191191

192192
Before signing a release with a new GPG key, it should be signed by other trusted
193193
keys and added to the [list of trusted keys in the repository](KEYS.md).
194+
195+
## Updating the docs website
196+
197+
Once the release is done. Create a pull request to the [docs repo](https://github.com/kinvolk/docs).
198+
Modify the Lokomotive
199+
[_index.md](https://github.com/kinvolk/docs/blob/master/docs/lokomotive/_index.md) file.
200+
201+
Now add a new entry at the top of the list with new version pointing to its corresponding tag:
202+
203+
```diff
204+
external_docs:
205+
+- repo: https://github.com/kinvolk/lokomotive.git
206+
+ name: "0.7"
207+
+ branch: "v0.7.0"
208+
+ dir: "docs"
209+
- repo: https://github.com/kinvolk/lokomotive.git
210+
name: "0.6"
211+
branch: "v0.6.0"
212+
dir: "docs"
213+
```

0 commit comments

Comments
 (0)