From 2154f2add89e051768c0045532dbbb727e397033 Mon Sep 17 00:00:00 2001 From: Ilya Kuznetsov Date: Tue, 21 Jan 2025 16:05:01 +0100 Subject: [PATCH] fix: Remove unnecessary `vendor` make dependency --- Makefile | 2 +- bundle/internal/docs/README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 4d1e07535..c5bfd7db0 100644 --- a/Makefile +++ b/Makefile @@ -49,7 +49,7 @@ vendor: schema: go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema.json -docs: vendor +docs: 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 79f9714cf..80884ae38 100644 --- a/bundle/internal/docs/README.md +++ b/bundle/internal/docs/README.md @@ -1,7 +1,7 @@ ## docs-autogen 1. Install [Golang](https://go.dev/doc/install) -2. Run `make docs` from the repo +2. Run `make vendor 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` @@ -31,6 +31,7 @@ Descriptions with `PLACEHOLDER` value are not displayed in docs and JSON-schema All relative links like `[_](/dev-tools/bundles/settings.md#cluster_id)` are kept as is in docs but converted to absolute links in JSON schema To change description for type itself (not its fields) use `"_"`: + ```yaml github.com/databricks/cli/bundle/config/resources.Cluster: "_":