Skip to content

Commit

Permalink
Add index.md file with automation (#628)
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.

Similar to pulumi/pulumi-newrelic#890, this is
probably blocked on
pulumi/pulumi-terraform-bridge#2466 due to
poor table rendering.

Update: This is awaiting the latest bridge; the table is rendered nicely
now:
<img width="750" alt="Screenshot 2024-11-11 at 10 49 14 AM"
src="https://github.com/user-attachments/assets/becb265c-0e7d-42ee-a89e-b1b49bd3127e">


- **first docsgen**
- **Remove TF-specific headers and clean up top-level Description**
- **Tweak regexp for header text matching**
- **Remove note as well**
- **Remove secrets warning**
  • Loading branch information
guineveresaenger authored Dec 2, 2024
2 parents b313a92 + a5a7188 commit 7e815fa
Show file tree
Hide file tree
Showing 7 changed files with 1,764 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 @@ -24,6 +24,7 @@ plugins:
- name: std
version: "1.6.2"
pulumiConvert: 1
registryDocs: true
license:
ignore:
- github.com/databricks/terraform-provider-databricks/shim
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,10 @@ build_python: .make/build_python
@touch $@
.PHONY: generate_python build_python

# 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}
rm -rf bin/*
Expand Down
Loading

0 comments on commit 7e815fa

Please sign in to comment.