Skip to content

Commit

Permalink
Add installation docs (#519)
Browse files Browse the repository at this point in the history
This PR automates docsgen for this provider's installation doc.

Part of pulumi/home#3598.

- **Add automation for index doc**
- **Skip secrets warning**
  • Loading branch information
guineveresaenger authored Oct 31, 2024
1 parent 7446e63 commit 2b50985
Show file tree
Hide file tree
Showing 4 changed files with 432 additions and 1 deletion.
1 change: 1 addition & 0 deletions .ci-mgmt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ env:
makeTemplate: bridged
team: ecosystem
pulumiConvert: 1
registryDocs: true
plugins:
- name: terraform
version: "1.0.16"
Expand Down
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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}

Expand Down
Loading

0 comments on commit 2b50985

Please sign in to comment.