Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation docs #508

Merged
merged 2 commits into from
Sep 19, 2024
Merged

Conversation

guineveresaenger
Copy link
Contributor

Part of pulumi/home#3598

Generates a single index.md file with relevant content.

@guineveresaenger guineveresaenger requested a review from a team September 17, 2024 23:20
Copy link

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

Maintainer note: consult the runbook for dealing with any breaking changes.

@guineveresaenger guineveresaenger added the needs-release/patch When a PR with this label merges, it initiates a release of vX.Y.Z+1 label Sep 17, 2024
docs/_index.md Outdated
Comment on lines 15 to 16
## Overview
<!-- schema generated by tfplugindocs -->
Copy link
Member

@iwahbe iwahbe Sep 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't insert empty ## Overview sections. Can you open an issue in the bridge?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arguably, this is an issue with the upstream docs being wrong/inclomplete - expecting an introduction seems reasonable.

Anyway. Addressed this in pulumi/pulumi-terraform-bridge@415a9ca and applied here.

Copy link
Member

@iwahbe iwahbe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was removing ## Overview a manual change?

@guineveresaenger
Copy link
Contributor Author

No, this was generated with pulumi/pulumi-terraform-bridge@415a9ca.

@guineveresaenger guineveresaenger merged commit 8802855 into master Sep 19, 2024
23 checks passed
@guineveresaenger guineveresaenger deleted the guin/installation-instructions branch September 19, 2024 21:22
@pulumi-bot
Copy link
Contributor

This PR has been shipped in release v3.8.1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-release/patch When a PR with this label merges, it initiates a release of vX.Y.Z+1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants