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

Maintenance: Improve example documentation #1289

Closed
1 of 2 tasks
scottgerring opened this issue Jul 14, 2023 · 2 comments
Closed
1 of 2 tasks

Maintenance: Improve example documentation #1289

scottgerring opened this issue Jul 14, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers maintenance priority:2 High - core feature or affects 60% of the users

Comments

@scottgerring
Copy link
Contributor

Summary

Apart from powertools-core, the example documentation READMEs miss usage instructions beyond "deploy with SAM".

Why is this needed?

This makes it hard to use the examples. For instance, in the case of the idempotency demo, a particular JSON body needs to be POSTed to the API created, which is not obvious. This friction reduces the value of the

Which area does this relate to?

Other

Solution

Improve the documentation of the following examples to describe 1/ how to use them and 2/ what they are doing and why.

While we are at it, let's go through the code itself and make sure it is up to date and clear.

Finally, the main powertools documentation should be updated to link to the relevant demos for each piece of code.

Acknowledgment

@scottgerring scottgerring added documentation Improvements or additions to documentation good first issue Good for newcomers maintenance labels Jul 14, 2023
@jeromevdl jeromevdl added the priority:2 High - core feature or affects 60% of the users label Jul 17, 2023
@scottgerring
Copy link
Contributor Author

For the powertools-idempotency example, the user must POST a JSON object in the following format:

{
	"address": "https://checkip.amazonaws.com"
}

The example will retrieve the data at the URL.

@scottgerring scottgerring self-assigned this Jul 17, 2023
@scottgerring
Copy link
Contributor Author

I'll pick this up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers maintenance priority:2 High - core feature or affects 60% of the users
Projects
None yet
Development

No branches or pull requests

2 participants