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

Test customized docsgen #3708

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Conversation

t0yv0
Copy link
Member

@t0yv0 t0yv0 commented Jan 2, 2024

Description

Adding a new package?

If this pull request adds a new package:

  • The package's schema URL is correct.
  • The package metadata file, if present, contains:
    • a supported category (one of Cloud, Infrastructure, Network, Database, Monitoring, or Utility).
    • a description that explains what the package does.
    • a valid logo URL that points to a PNG whose dimensions conform to the others in this repo (e.g., 100x100).
    • a version number prefixed with v that corresponds with a valid GitHub release.
  • The package repo contains an Overview doc (/docs/_index.md) that includes:
    • a brief explanation of what the package is and what it does.
    • at least one representative example in all supported languages.
    • a front-matter property for the layout set to package.
  • The package repo contains an Installation and Configuration doc (/docs/installation-configuration.md) that includes:
    • links to SDKs in all supported languages.
    • a copyable command for installing the resource plugin if necessary.
    • an example of configuring the provider with pulumi config set.
    • an example of configuring the provider with environment variables.
  • Someone from the @pulumi/ai team has reviewed the PR.
  • Someone from the @pulumi/docs team has reviewed all documentation.

@t0yv0
Copy link
Member Author

t0yv0 commented Jan 2, 2024

This is an attempt to test how pulumi/pulumi#14822 affects the registry.

@t0yv0
Copy link
Member Author

t0yv0 commented Jan 2, 2024

Looks like registry needs to be on Go 1.20.x

https://pkg.go.dev/strings#CutPrefix missing

@t0yv0
Copy link
Member Author

t0yv0 commented Jan 2, 2024

Looks like something in AWS metadata is in violation of a recently introduced check pulumi/pulumi#14637

@t0yv0
Copy link
Member Author

t0yv0 commented Jan 2, 2024

Actually that was pulumi/pulumi-aws-iam#19

Copy link

github-actions bot commented Jan 2, 2024

Your site preview for commit 61e4406 is ready! 🎉

http://registry--origin-pr-3708-61e44067.s3-website.us-west-2.amazonaws.com/registry.

Registry site previews only include API docs for the AWS and Aiven packages by default. You will not be able to navigate to other docs from the preview link. To see those docs, the PR author can add the desired package name to the list in scripts/ci/build.sh. How-to guides for all packages are also incomplete.

Copy link

github-actions bot commented Jan 4, 2024

Your site preview for commit 417d72a is ready! 🎉

http://registry--origin-pr-3708-417d72a5.s3-website.us-west-2.amazonaws.com/registry.

Registry site previews only include API docs for the AWS and Aiven packages by default. You will not be able to navigate to other docs from the preview link. To see those docs, the PR author can add the desired package name to the list in scripts/ci/build.sh. How-to guides for all packages are also incomplete.

@cnunciato
Copy link
Member

Looks like registry needs to be on Go 1.20.x

@t0yv0 Sorry about that -- this should fix that up: #3730

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