Skip to content

Commit

Permalink
docs: add an auto-generated disclaimer in gRPC API doc
Browse files Browse the repository at this point in the history
Signed-off-by: Mahe Tardy <[email protected]>
  • Loading branch information
mtardy committed Aug 2, 2023
1 parent f22b57b commit 59a9e08
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
2 changes: 1 addition & 1 deletion api/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ v1:
--user "$(shell id -u):$(shell id -g)" \
$(BUILDER_IMAGE) \
make -C /src -f Makefile.protoc
./export-docs.sh ../docs/content/en/docs/reference/grpc-api.md
./export-doc.sh ../docs/content/en/docs/reference/grpc-api.md

.PHONY: vendor
vendor:
Expand Down
7 changes: 6 additions & 1 deletion api/export-docs.sh → api/export-doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,13 @@ description: >
documents the gRPC API of Tetragon.
---
{{< comment >}}
This page was generated with github.io/cilium/tetragon/api/export-doc.sh,
please do not edit directly.
{{< /comment >}}
The Tetragon API is an independant Go module that can be found in the Tetragon
repository under [api](https://github.com/cilium/tetragon/tree/main/api). The
version 1 of this API is defined in
[api/v1/tetragon](https://github.com/cilium/tetragon/tree/main/api/v1/tetragon).' | cat - $TMP_FILE > $1
[github.com/cilium/tetragon/api/v1/tetragon](https://github.com/cilium/tetragon/tree/main/api/v1/tetragon).' | cat - $TMP_FILE > $1

7 changes: 6 additions & 1 deletion docs/content/en/docs/reference/grpc-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,15 @@ description: >
documents the gRPC API of Tetragon.
---

{{< comment >}}
This page was generated with github.io/cilium/tetragon/api/export-doc.sh,
please do not edit directly.
{{< /comment >}}

The Tetragon API is an independant Go module that can be found in the Tetragon
repository under [api](https://github.com/cilium/tetragon/tree/main/api). The
version 1 of this API is defined in
[api/v1/tetragon](https://github.com/cilium/tetragon/tree/main/api/v1/tetragon).
[github.com/cilium/tetragon/api/v1/tetragon](https://github.com/cilium/tetragon/tree/main/api/v1/tetragon).

## tetragon/capabilities.proto

Expand Down

0 comments on commit 59a9e08

Please sign in to comment.