Update resourcedocsgen to pull in the latest from pulumi/pulumi
#9661
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
cnunciato
force-pushed
the
cnunciato/registry-2924
branch
4 times, most recently
from
995136a
to
cb9a8d2
Compare
6 tasks
bors bot
added a commit
to pulumi/pulumi
that referenced
this pull request
Aug 11, 2023
13703: Fix inconsistent names of supporting types in docs r=cnunciato a=cnunciato # Description This change fixes a naming inconsistency among supporting/nested types among different languages in the resource docs. Currently, when either Python or Go is selected, the links to supporting types in property lists are labeled (correctly) using with `Args` suffixes, but those links point to headings that don't contain those suffixes:  Additionally, when other languages are selected (JS/TS, C#, Java, YAML), these links contain `Args` suffixes when they shouldn't -- e.g., for TypeScript, for which the `corsRules` property of `aws.s3.Bucket` is listed as a `BucketCorsRuleArgs[]`, but is actually a `BucketCorsRule[]`:  Both of these can lead to confusion. This change adds some logic to remove `Args` suffixes from property lists in languages other than Python and Go (where they're correct) and, for Python and Go, shows the `-Args` version of the type's display name in the heading as well. A preview of these changes can be seen here (via [this Docs PR](pulumi/docs#9661)): http://www-pulumi-docs-origin-pr-9661-cb9a8d22.s3-website.us-west-2.amazonaws.com/registry/packages/aws/api-docs/s3/bucket/  Fixes pulumi/registry#2924. Fixes pulumi/registry#1524. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [ ] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [ ] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- `@Pulumi` employees: If yes, you must submit corresponding changes in the service repo. --> Co-authored-by: Christian Nunciato <[email protected]>
cnunciato
force-pushed
the
cnunciato/registry-2924
branch
3 times, most recently
from
1707868
to
fa794cc
Compare
cnunciato
changed the title
resourcedocsgen to pull in the latest from pulumi/pulumi
cnunciato
force-pushed
the
cnunciato/registry-2924
branch
from
fa794cc
to
77c4507
Compare
sean1588
approved these changes
Aug 11, 2023
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.
Updates the
pulumi/pulumidependencies inresourcedocsgento pick up the changes in pulumi/pulumi#13703, and adds a few details to the README to better explain how to iterate on changes to API docs templates.