registry icon indicating copy to clipboard operation
registry copied to clipboard

Test customized docsgen

Open t0yv0 opened this issue 1 year ago • 7 comments

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 avatar Jan 02 '24 16:01 t0yv0

This is an attempt to test how https://github.com/pulumi/pulumi/pull/14822 affects the registry.

t0yv0 avatar Jan 02 '24 16:01 t0yv0

Looks like registry needs to be on Go 1.20.x

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

t0yv0 avatar Jan 02 '24 16:01 t0yv0

Looks like something in AWS metadata is in violation of a recently introduced check https://github.com/pulumi/pulumi/pull/14637/

t0yv0 avatar Jan 02 '24 17:01 t0yv0

Actually that was https://github.com/pulumi/pulumi-aws-iam/pull/19

t0yv0 avatar Jan 02 '24 17:01 t0yv0

Your site preview for commit 61e44067 is ready! :tada:

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.

github-actions[bot] avatar Jan 02 '24 20:01 github-actions[bot]

Your site preview for commit 417d72a5 is ready! :tada:

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.

github-actions[bot] avatar Jan 04 '24 22:01 github-actions[bot]

Looks like registry needs to be on Go 1.20.x

@t0yv0 Sorry about that -- this should fix that up: https://github.com/pulumi/registry/pull/3730

cnunciato avatar Jan 05 '24 16:01 cnunciato