From 470276f5a98469847f3243c748f9e7a8edb259e9 Mon Sep 17 00:00:00 2001 From: guineveresaenger Date: Fri, 25 Oct 2024 10:50:40 -0700 Subject: [PATCH] Add installation doc automation --- .ci-mgmt.yaml | 1 + Makefile | 6 +++++- docs/_index.md | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.ci-mgmt.yaml b/.ci-mgmt.yaml index 8b20e2e7..b508e324 100644 --- a/.ci-mgmt.yaml +++ b/.ci-mgmt.yaml @@ -10,6 +10,7 @@ upstream-provider-repo: terraform-provider-bigip makeTemplate: bridged team: ecosystem pulumiConvert: 1 +registryDocs: true plugins: - name: std version: "1.6.2" diff --git a/Makefile b/Makefile index 546f7291..9d2c9ace 100644 --- a/Makefile +++ b/Makefile @@ -29,7 +29,7 @@ development: install_plugins provider build_sdks install_sdks build: install_plugins provider build_sdks install_sdks -build_sdks: build_nodejs build_python build_dotnet build_go build_java +build_sdks: build_nodejs build_python build_dotnet build_go build_java build_registry_docs install_go_sdk: @@ -96,6 +96,10 @@ build_python: upstream cd ./bin && \ ../venv/bin/python -m build . +# Run the bridge's registry-docs command to generated the content of the installation docs/ folder at provider repo root +build_registry_docs: + $(WORKING_DIR)/bin/$(TFGEN) registry-docs --out $(WORKING_DIR)/docs + clean: rm -rf sdk/{dotnet,nodejs,go,python} diff --git a/docs/_index.md b/docs/_index.md index 229e3665..29301b5b 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -13,6 +13,7 @@ The bigip provider is available as a package in all Pulumi languages: * .NET: [`Pulumi.Bigip`](https://www.nuget.org/packages/Pulumi.Bigip) * Java: [`com.pulumi/bigip`](https://central.sonatype.com/artifact/com.pulumi/bigip) ## Overview + Use the F5 BIG-IP Pulumi Provider to manage and provision your BIG-IP configurations in Pulumi. Using BIG-IP Provider you can manage LTM(Local Traffic Manager),Network,System objects and it also supports AS3/DO integration. ### Requirements