diff --git a/Makefile b/Makefile index 20b868a61..6cfc458aa 100644 --- a/Makefile +++ b/Makefile @@ -37,7 +37,7 @@ vendor: schema: go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema.json -docs: +docs: vendor go run ./bundle/internal/docs ./bundle/internal/schema ./bundle/internal/docs INTEGRATION = gotestsum --format github-actions --rerun-fails --jsonfile output.json --packages "./integration/..." -- -parallel 4 -timeout=2h diff --git a/bundle/internal/docs/README.md b/bundle/internal/docs/README.md index 0dd5727f4..bd61e3ee8 100644 --- a/bundle/internal/docs/README.md +++ b/bundle/internal/docs/README.md @@ -1,10 +1,9 @@ ## docs-autogen 1. Install [Golang](https://go.dev/doc/install) -2. Run `go mod download` from the repo root -3. Run `make docs` from the repo -4. See generated documents in `./bundle/internal/docs/output` directory -5. To change descriptions update content in `./bundle/internal/schema/annotations.yml` or `./bundle/internal/schema/annotations_openapi_overrides.yml` and re-run `make docs` +2. Run `make docs` from the repo +3. See generated documents in `./bundle/internal/docs/output` directory +4. To change descriptions update content in `./bundle/internal/schema/annotations.yml` or `./bundle/internal/schema/annotations_openapi_overrides.yml` and re-run `make docs` For simpler usage run it together with copy command to move resulting files to local `docs` repo. Note that it will overwrite any local changes in affected files. Example: