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

Upstream installation instructions: Docs Edits and Transformations #2078

Closed
9 of 10 tasks
guineveresaenger opened this issue Jun 10, 2024 · 3 comments
Closed
9 of 10 tasks
Assignees
Labels
kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features resolution/fixed This issue was fixed
Milestone

Comments

@guineveresaenger
Copy link
Contributor

guineveresaenger commented Jun 10, 2024

Part of pulumi/registry#4749.

#2068 adds the ability to emit the upstream index.md file, where top-level provider information lives, into a docs folder in the Pulumi provider, which is where the registry can find the file if it exists, exactly as we are doing for third party providers today.

To emit these docs properly, the following requirements must be met before emitting this file:

  • Apply default doc edit rules
  • Convert examples
  • Add Hugo shortcodes to any examples so we can obtain the code chooser
  • Transform TF names to Pulumi names
  • Ability to skip irrelevant sections (e.g. terraform-specific logging, contributing) via docs edit rules
  • Nice-to-have: Include pulumi config set... instructions
  • Nice-to-have: Show provider config file
  • Light rewording of "Argument Reference" "block supports the following"
  • Include installation section
  • Add registry Hugo frontmatter
@guineveresaenger
Copy link
Contributor Author

This is ready to be rolled out on select Tier 3 providers. Note that the Akamai provider keeps their installation docs elsewhere so we'll have to come up with an alternative.

@mjeffryes mjeffryes modified the milestones: 0.108, 0.109 Aug 19, 2024
@iwahbe
Copy link
Member

iwahbe commented Aug 20, 2024

I have created an issue to track rollout: https://github.com/pulumi/home/issues/3598

@mjeffryes mjeffryes modified the milestones: 0.109, 0.110 Sep 12, 2024
@mjeffryes mjeffryes modified the milestones: 0.110, 0.111 Oct 2, 2024
@mjeffryes mjeffryes modified the milestones: 0.111, 0.112 Oct 30, 2024
@mjeffryes mjeffryes modified the milestones: 0.112, 0.113 Nov 13, 2024
@guineveresaenger guineveresaenger added the resolution/fixed This issue was fixed label Dec 2, 2024
@guineveresaenger
Copy link
Contributor Author

Rollout is complete.

This issue is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features resolution/fixed This issue was fixed
Projects
None yet
Development

No branches or pull requests

3 participants