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 file #426

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Add installation file #426

merged 2 commits into from
Oct 24, 2024

Conversation

guineveresaenger
Copy link
Contributor

@guineveresaenger guineveresaenger commented Sep 20, 2024

Part of pulumi/home#3598

Generates a single index.md file with relevant content.

This file was generated against a version of the plainDocsParser that runs provider-supplied editRules before code conversion, as several code blocks in the upstream docs caused an empty example and incorrect code choosers for what is a shell example. Depends on incoming bridge changes.

With added automation, this is blocked awaiting the next bridge release.

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 added a commit to pulumi/pulumi-terraform-bridge that referenced this pull request Oct 2, 2024
…ne and apply for installation docs (#2435)

This code is required to successfully apply the edit rules needed for
pulumi/pulumi-libvirt#426.

It covers the case for when the upstream file's code sections need to be
adjusted for code conversion to work.

It adds a complete index file test which tests the entire
`plainDocsParser` function.
In support of pulumi/home#3598.

- **Run provider-supplied edit rules before example conversion. Add
complete file tests, with and without provider-supplied edits**
- **clean up tests**
@guineveresaenger guineveresaenger requested a review from a team October 9, 2024 18:24
@guineveresaenger guineveresaenger marked this pull request as ready for review October 9, 2024 18:24
@guineveresaenger guineveresaenger added needs-release/patch When a PR with this label merges, it initiates a release of vX.Y.Z+1 awaiting-upstream The issue cannot be resolved without action in another repository (may be owned by Pulumi). blocked The issue cannot be resolved without 3rd party action. awaiting/bridge The issue cannot be resolved without action in pulumi-terraform-bridge. and removed awaiting-upstream The issue cannot be resolved without action in another repository (may be owned by Pulumi). labels Oct 9, 2024
…de for a beautiful representation. But this needs a bridge change.
@guineveresaenger guineveresaenger removed blocked The issue cannot be resolved without 3rd party action. awaiting/bridge The issue cannot be resolved without action in pulumi-terraform-bridge. labels Oct 22, 2024
@guineveresaenger guineveresaenger merged commit c892cf0 into master Oct 24, 2024
23 checks passed
@guineveresaenger guineveresaenger deleted the guin/installation-docs branch October 24, 2024 20:38
@pulumi-bot
Copy link
Contributor

This PR has been shipped in release v0.5.3.

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

Successfully merging this pull request may close these issues.

3 participants