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

[docs] Consider applying certain editRules after code translation #2459

Open
guineveresaenger opened this issue Oct 1, 2024 · 0 comments
Open
Labels
area/docs Improvements or additions to docs for this repo kind/enhancement Improvements or new features

Comments

@guineveresaenger
Copy link
Contributor

guineveresaenger commented Oct 1, 2024

Hello!

The current status quo in the bridge is that we have a small set of defaultEditRules for the docs. These cannot be too aggressive currently. For instance, we cannot remove any terraform strings, because we rely on those during example translation, but docs edit rules, default, and provider-supplied, run bevore code conversions of any kind. The end result is that we then elide multiple docs sections for containing the word terraform when we should instead edit the doc again to (for instance) replace those with "pulumi". We also rely on certain header texts to match discovered docs to our schema, with certain verbiage or header level corresponding to nestedness.

Issue details

#2435 introduces the pattern of running docs edits both before (the current process for registry docs) and after code conversion to Pulumi languages, which allows for much more aggressive replacements. It is only used for installation docs in the provider's docs/_index file.

Implementing this feature would result in fewer elided docs.

Affected area/feature

Registry docsgen for resources and functions.

@guineveresaenger guineveresaenger added area/docs Improvements or additions to docs for this repo kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Oct 1, 2024
@VenelinMartinov VenelinMartinov removed the needs-triage Needs attention from the triage team label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to docs for this repo kind/enhancement Improvements or new features
Projects
None yet
Development

No branches or pull requests

2 participants