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

Update README #5876

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update README #5876

wants to merge 5 commits into from

Conversation

sean1588
Copy link
Member

@sean1588 sean1588 commented Nov 1, 2024

Description

Updates the readme to accurately reflect the current state of the world.

See https://github.com/pulumi/registry/tree/sean/readme-updates

Copy link

github-actions bot commented Nov 1, 2024

Your site preview for commit 8c00aff is ready! 🎉

http://registry--origin-pr-5876-8c00aff7.s3-website.us-west-2.amazonaws.com/registry.

Copy link

github-actions bot commented Nov 4, 2024

Your site preview for commit 98aa61a is ready! 🎉

http://registry--origin-pr-5876-98aa61ae.s3-website.us-west-2.amazonaws.com/registry.

README.md Outdated Show resolved Hide resolved
README.md Outdated
This will modify `go.mod` and `go.sum` accordingly and result in a PR preview that incorporates your changes from the other branch. Just be sure to remove these changes before you're ready to merge.

If you would like to generate API docs for packages beyond AWS and Aiven (the docs available in PR previews by default), add the package name you would like docs for [in this file](https://github.com/pulumi/registry/blob/master/scripts/ci/build.sh#L5). Be sure to remove these changes before merging.
If you would like to generate API docs for packages beyond AWS and Aiven (the docs available in PR previews by default), add the package name you would like docs for [in this file](https://github.com/pulumi/registry/blob/master/scripts/ci/build.sh#L5). Be sure to remove these changes before merging.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Observationally, this is no longer true. I don't see any mention of AWS or Aiven in scripts/ci/build.sh, and the registry builds all docs packages by in PR reviews:

For example (from this PR as I review it):
http://registry--origin-pr-5876-98aa61ae.s3-website.us-west-2.amazonaws.com/registry/packages/aws-native/api-docs/apigatewayv2/authorizer/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you I should have removed this one also. It is showing up as something new because of the way it diffs. yes we do generate all packages on builds now.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Ian Wahbe <me@iwahbe.com>
Co-authored-by: Ian Wahbe <me@iwahbe.com>
Copy link

github-actions bot commented Nov 4, 2024

Your site preview for commit 3d1eb5d is ready! 🎉

http://registry--origin-pr-5876-3d1eb5d5.s3-website.us-west-2.amazonaws.com/registry.

Copy link

github-actions bot commented Nov 4, 2024

Your site preview for commit 43fdf73 is ready! 🎉

http://registry--origin-pr-5876-43fdf733.s3-website.us-west-2.amazonaws.com/registry.

Copy link

github-actions bot commented Nov 4, 2024

Your site preview for commit 437c523 is ready! 🎉

http://registry--origin-pr-5876-437c523d.s3-website.us-west-2.amazonaws.com/registry.

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.

2 participants