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

AWS API Gateway Guide includes inaccurate example reference #10266

Closed
mnlumi opened this issue Nov 16, 2023 · 4 comments · Fixed by pulumi/pulumi-hugo#3735
Closed

AWS API Gateway Guide includes inaccurate example reference #10266

mnlumi opened this issue Nov 16, 2023 · 4 comments · Fixed by pulumi/pulumi-hugo#3735
Assignees
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features resolution/fixed This issue was fixed size/M Estimated effort to complete (up to 5 days).
Milestone

Comments

@mnlumi
Copy link
Contributor

mnlumi commented Nov 16, 2023

Problem description

On https://www.pulumi.com/docs/clouds/aws/guides/api-gateway/#overview, there's a line that says "Full examples can be found in the AWS API Gateway component in the Pulumi Registry." When actually visiting the registry page, there are no real examples. The API Gateway docs page has more examples.

Suggestions for a fix

Either the language on the docs page should be corrected, or helpful examples be added to the registry page.

@mnlumi mnlumi added the needs-triage Needs attention from the triage team label Nov 16, 2023
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Nov 16, 2023
@desteves
Copy link
Contributor

@mnlumi I agree the word "full" is a bit subjective. @pulumi/docs I suggest we update the wording to omit the word "full".

I do see examples when following the link to https://www.pulumi.com/registry/packages/aws-apigateway/ so I'm unclear on the "no real examples" part. Could you share a bit more of what you expected to see?

@mnlumi
Copy link
Contributor Author

mnlumi commented Nov 17, 2023

Well, I could swear I didn't see that example when I looked before. I think I was expecting more under resources or to have the how-to-guides section there.

@desteves desteves removed the needs-triage Needs attention from the triage team label Nov 20, 2023
@desteves desteves moved this from 🤔 Triage to 🎬 Ready in Docs 📚 Nov 20, 2023
@desteves desteves added this to the 0.97 milestone Nov 20, 2023
@desteves desteves added area/docs Improvements or additions to documentation size/M Estimated effort to complete (up to 5 days). labels Nov 20, 2023
@cnunciato cnunciato assigned cnunciato and unassigned interurban Dec 11, 2023
@cnunciato cnunciato modified the milestones: 0.97, 0.98 Dec 11, 2023
@cnunciato cnunciato moved this from 🎬 Ready to 🔧 In Progress in Docs 📚 Dec 11, 2023
@cnunciato
Copy link
Contributor

Updating the prose in the guide to point to the Registry for "more information" (syntax reference, etc.).

@github-project-automation github-project-automation bot moved this from 🔧 In Progress to 🏁 Done in Docs 📚 Dec 18, 2023
@pulumi-bot pulumi-bot added the resolution/fixed This issue was fixed label Dec 18, 2023
@pulumi-bot
Copy link
Collaborator

Cannot close issue:

  • does not have required labels: kind/

Please fix these problems and try again.

@pulumi-bot pulumi-bot reopened this Dec 18, 2023
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Dec 18, 2023
@cnunciato cnunciato added kind/enhancement Improvements or new features and removed needs-triage Needs attention from the triage team labels Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features resolution/fixed This issue was fixed size/M Estimated effort to complete (up to 5 days).
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants