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

Migrate pulumi-owned package installation docs to live in provider repos #4740

Closed
Tracked by #2083
guineveresaenger opened this issue Jun 12, 2024 · 2 comments
Closed
Tracked by #2083
Assignees
Labels
kind/engineering Work that is not visible to an external user needs-triage Needs attention from the triage team resolution/fixed This issue was fixed

Comments

@guineveresaenger
Copy link
Contributor

guineveresaenger commented Jun 12, 2024

All _index.md and installation-configuration.md files that are currently in pulumi/registry can and should live in a pulumi-foo/docs/ folder.

The Registry can and does detect these files for third-party providers, and we should use the same process. Using the in-registry folder is currently fallback behavior reserved for Pulumi-maintained packages.

Suggested process:

  1. Audit which packages are being actively maintained (we don't need to chase down unmaintained providers)
  2. Create a one-time migration script to copy these files into each provider and open a pull request
  3. Remove the registry files if all looks correct.

Update

This issue is being tracked in https://github.com/pulumi/home/issues/3598. Rather than copying old, stale information, we are generating the installation docs in the provider and have added functionality to the registry that will

The revised process is:

  1. Create a docs/_index.md file at the root of the provider. The registry will use this file to render the provider landing page.
  2. For lower-tier bridged providers, this file will be generated with the bridge's registry-docs command.
  3. This generation will be automated via Add registry docs option to bridged provider CI config ci-mgmt#1083 and Run registry docs command from correct file location ci-mgmt#1085.

For a first pass to ensure that the landing page looks excellent, we're rolling the initial changes out one by one, rather than automatically.

I'm closing this issue in favor of https://github.com/pulumi/home/issues/3598.

@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Jun 12, 2024
@guineveresaenger guineveresaenger added the kind/engineering Work that is not visible to an external user label Jun 12, 2024
@interurban interurban added size/M Estimated effort to complete (up to 5 days). and removed needs-triage Needs attention from the triage team labels Jun 17, 2024
@pulumi-bot pulumi-bot reopened this Sep 30, 2024
@pulumi-bot
Copy link
Collaborator

Cannot close issue:

  • does not have required labels: resolution/

Please fix these problems and try again.

@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Sep 30, 2024
@ericrudder ericrudder added the resolution/fixed This issue was fixed label Sep 30, 2024
@guineveresaenger guineveresaenger removed size/M Estimated effort to complete (up to 5 days). kind/engineering Work that is not visible to an external user needs-triage Needs attention from the triage team labels Sep 30, 2024
@pulumi-bot pulumi-bot reopened this Sep 30, 2024
@pulumi-bot
Copy link
Collaborator

Cannot close issue:

  • does not have required labels: kind/
  • does not have an assignee

Please fix these problems and try again.

@guineveresaenger guineveresaenger added the kind/engineering Work that is not visible to an external user label Sep 30, 2024
@guineveresaenger guineveresaenger self-assigned this Sep 30, 2024
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Sep 30, 2024
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 needs-triage Needs attention from the triage team resolution/fixed This issue was fixed
Projects
Status: 🏁 Done
Development

No branches or pull requests

4 participants