Skip to content

Commit 122f290

Browse files
committed
util: Update release issue template
1 parent 280f690 commit 122f290

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

.github/ISSUE_TEMPLATE/release.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,12 @@ $ tools/bin/mage ttiProto:hugoData
2626
- [ ] Copy generated files to `lorawan-stack-docs` with the following command:
2727

2828
```bash
29-
$ cp -r doc/data/api /path/to/lorawan-stack-docs/doc/data/
29+
$ cp api/ttn.lorawan.v3/*.yml ../lorawan-stack-docs/doc/data/api/ttn.lorawan.v3/
30+
$ cp api/tti.lorawan.v3/*.yml ../lorawan-stack-docs/doc/data/api/tti.lorawan.v3/
3031
```
3132

33+
> NOTE: Replace `../lorawan-stack-docs` if your `lorawan-stack-docs` folder is in a different location.
34+
3235
- [ ] To generate and export CLI documentation from within the clone of [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack), first run the following command to build the CLI:
3336

3437
```bash
@@ -38,9 +41,11 @@ $ go build -tags tti ./cmd/tti-lw-cli
3841
- [ ] Then export the CLI documentation using the following command:
3942

4043
```bash
41-
$ HOME=$HOME ./tti-lw-cli gen-yaml-doc -o /path/to/lorawan-stack-docs/doc/data/
44+
$ HOME='$HOME' ./tti-lw-cli gen-yaml-doc -o ../lorawan-stack-docs/doc/data/
4245
```
4346

47+
> NOTE: Replace `../lorawan-stack-docs` if your `lorawan-stack-docs` folder is in a different location.
48+
4449
#### Check (for reviewers)
4550

4651
- [ ] The documentation version is up to date.

0 commit comments

Comments
 (0)