-
Notifications
You must be signed in to change notification settings - Fork 44
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
Emit upstream Installation instructions #2068
Merged
guineveresaenger
merged 12 commits into
master
from
guin/emit-installation-instructions
Jun 14, 2024
Merged
Emit upstream Installation instructions #2068
guineveresaenger
merged 12 commits into
master
from
guin/emit-installation-instructions
Jun 14, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iwahbe
reviewed
Jun 6, 2024
10 tasks
… name as presented in the upstream header
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master pulumi/pulumi#2068 +/- ##
==========================================
- Coverage 61.57% 61.19% -0.39%
==========================================
Files 334 340 +6
Lines 44955 45215 +260
==========================================
- Hits 27681 27668 -13
- Misses 15750 16026 +276
+ Partials 1524 1521 -3 ☔ View full report in Codecov by Sentry. |
iwahbe
approved these changes
Jun 13, 2024
This was referenced Jul 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request is the scaffold implementation of generating installation docs for bridged providers from upstream source.
In this change, a new "language" called
registry-docs
is added to the bridge. (Note that "language" in this case is a bit of a misnomer - it is thetfgen
CLI's input for determining which generating tactic to use - this is whyschema
is a language as well).This change reads the upstream
index.md
file and emits it as a Pulumi package installation instruction file to a top-level folder calleddocs/
(the current registry standard). We also emit a minimal_index.md
file. When these files exist in a provider, the registry will use those instead of the hard coded files existing in the registry currently.This pull request includes a fair bit of TODOs in the docs parser - currently only the Hugo front matter is implemented, to show the scaffold. Transformations for this document to be Pulumi-friendly will follow in a separate PR.
This change does not affect any current use of the bridge - to flip it on, we'd add another Make target to a provider's Makefile, e.g.
./bin/pulumi-tfgen-openstack registry-docs --out docs/
. I'd like us to consider adding this change despite the TODOs, so we can keep the changes somewhat atomic and reduce merge conflicts.Closes #2082.