[docs] Consider applying certain editRules after code translation #2459
Labels
area/docs
Improvements or additions to docs for this repo
kind/enhancement
Improvements or new features
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 wordterraform
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.
The text was updated successfully, but these errors were encountered: