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

Elide Hashicorp from docs #1661

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Elide Hashicorp from docs #1661

merged 2 commits into from
Jan 31, 2024

Conversation

iwahbe
Copy link
Member

@iwahbe iwahbe commented Jan 31, 2024

Cleanup inspired by #1660.

Solving #1660 requires a deeper dive into how code cleanup relates to examples.

@iwahbe iwahbe requested a review from a team January 31, 2024 09:56
@iwahbe iwahbe self-assigned this Jan 31, 2024
@iwahbe iwahbe enabled auto-merge (squash) January 31, 2024 09:57
@VenelinMartinov
Copy link
Contributor

Should we really elide the examples? They might be perfectly valid otherwise. I think there's a precedent in AWS of replacing instead: https://github.com/pulumi/pulumi-aws/blob/8dc14b16493458bd85a374fbd37c50084718a827/provider/replacements.json#L434

Can't we do something like that here too?

@iwahbe
Copy link
Member Author

iwahbe commented Jan 31, 2024

Should we really elide the examples? They might be perfectly valid otherwise.

That is what we do with terraform, and is consistent with our existing strategy.

I think there's a precedent in AWS of replacing instead: https://github.com/pulumi/pulumi-aws/blob/8dc14b16493458bd85a374fbd37c50084718a827/provider/replacements.json#L434

Can't we do something like that here too?

AWS does this (as a custom pre-processor step), but the replaces are manual. If a replace is missed, it still elides. I'd be happy to build up a more robust set of replaces to fix elided docs.

@VenelinMartinov
Copy link
Contributor

VenelinMartinov commented Jan 31, 2024

This looks like a strict regression to me - the examples in #1660 are functionally fine, so I don't see why we would elide them.

Shouldn't we just replace ".*@hashicorp.com" with ".*@example.com" everywhere?

@iwahbe iwahbe merged commit e730ea4 into master Jan 31, 2024
7 checks passed
@iwahbe iwahbe deleted the iwahbe/1660/elide-hashi branch January 31, 2024 14:08
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.

None yet

2 participants