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

[Deploy docs] - Finish/Fix DynamoDB example #73

Open
cknight opened this issue May 17, 2023 · 1 comment
Open

[Deploy docs] - Finish/Fix DynamoDB example #73

cknight opened this issue May 17, 2023 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed tutorial

Comments

@cknight
Copy link
Contributor

cknight commented May 17, 2023

What problem are you trying to solve?

The Connect to DynamoDB docs page has snippets of useful information but is ultimately a let down as there are large gaps that need filled in on your own. It would be far more useful to have a complete working example. Specific issues:

  • Gather credentials from DynamoDB

My experience in getting credentials was different to this. This may be my inexperience of using AWS, but should be checked for currency.

  • Write code that connects to DynamoDB

By referencing new ApiFactory().makeNew(DynamoDB) I am assuming that you are referencing https://deno.land/x/aws_api but there is no mention of this anywhere on the page nor any imports anywhere to guide you. Also, there is a strong caveat to using this library, namely:

Do not use this module in mission critical stuff. It's supposed to be for automation scripts, quick & dirty pieces of infrastructure, and prototype microservices and so on. If you just want the real, full-fat AWS SDK, a port of it has been uploaded at /x/aws_sdk.

Either use this library and highlight the caveat or show the example using the official AWS SDK.

Also, this line const data = await client.send(command); is thrown in without any suggestion where command comes from, how to construct it, what it looks like, etc.

Describe the solution you'd like

The docs for this are too light, much is left to the reader to work out and do a disservice to anyone attempting to follow them. Either this example should be properly and more thoroughly completed or this page removed.

Describe alternatives you've considered

As per above, complete this example or remove this page.

Documentation, Adoption, Migration Strategy

No response

@cknight cknight added the enhancement New feature or request label May 17, 2023
@kwhinnery kwhinnery transferred this issue from denoland/deploy_feedback Sep 15, 2023
@hashrock hashrock added tutorial help wanted Extra attention is needed labels Sep 25, 2023
@hashrock
Copy link
Contributor

related to this issue, there's a deadlink in DynamoDB tutorial

https://deno.com/examples/dynamo.js

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed tutorial
Projects
None yet
Development

No branches or pull requests

2 participants