Skip to content

Commit 431b7ea

Browse files
committed
Add a Make target
...for generating dynamic resource reference documentation
1 parent 0d1058b commit 431b7ea

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

Makefile

+4
Original file line numberDiff line numberDiff line change
@@ -1851,3 +1851,7 @@ go-mod-tidy-all:
18511851
dump-preset-roles:
18521852
GOOS=$(OS) GOARCH=$(ARCH) $(CGOFLAG) go run ./build.assets/dump-preset-roles/main.go
18531853
pnpm test web/packages/teleport/src/Roles/RoleEditor/StandardEditor/standardmodel.test.ts
1854+
1855+
.PHONY: gen-resource-docs
1856+
gen-resource-docs:
1857+
cd docs/resource-ref-generator && go run resource-ref-generator -config config.yaml

docs/resource-ref-generator/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ It uses the Teleport source as the basis for the guide.
66

77
## Usage
88

9+
From the root of your `gravitational/teleport` clone:
10+
911
```
10-
$ cd docs/resource-ref-generator
11-
$ go run . -config config.yaml
12+
$ make gen-resource-docs
1213
```
1314

1415
## How it works

0 commit comments

Comments
 (0)