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

docs(idempotency): API docs for idempotency #1485

Merged
merged 18 commits into from
Jun 12, 2023
Merged

docs(idempotency): API docs for idempotency #1485

merged 18 commits into from
Jun 12, 2023

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Jun 7, 2023

Description of your changes

  • bump typedoc deps
  • add typedoc config per package with a base configuration in the root folder, this helps us to control the entryPoints for each package
  • add api docs for idempotency
  • changed idempotency README to specifics of that package and additional information to the root README.

Related issues, RFCs

Issue number: #1104

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@am29d am29d requested a review from dreamorosi June 7, 2023 09:11
@boring-cyborg boring-cyborg bot added idempotency This item relates to the Idempotency Utility parameters This item relates to the Parameters Utility dependencies Changes that touch dependencies, e.g. Dependabot, etc. internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) tests PRs that add or change tests labels Jun 7, 2023
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Jun 7, 2023
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Hey Alex, thanks for the great work - I appreciate that you took the time to improve the API docs for the whole project and standardized the configs!

I have left a few comments, mostly minor ones, except one related to the imports and exports. See more details below - happy to discuss it further later if needed.

tsconfig.json Outdated Show resolved Hide resolved
typedoc.base.json Outdated Show resolved Hide resolved
packages/idempotency/src/persistence/index.ts Outdated Show resolved Hide resolved
packages/idempotency/src/index.ts Outdated Show resolved Hide resolved
packages/idempotency/README.md Outdated Show resolved Hide resolved
@am29d am29d requested a review from dreamorosi June 12, 2023 07:57
typedoc.json Outdated Show resolved Hide resolved
@dreamorosi dreamorosi changed the title chore(docs): API docs for idempotency docs(idempotency): API docs for idempotency Jun 12, 2023
Copy link
Contributor Author

@am29d am29d left a comment

Choose a reason for hiding this comment

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

good catch

@am29d am29d requested a review from dreamorosi June 12, 2023 10:17
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Good work with this PR, the new docs are looking nice.

I think we should include the BaseProvider class for Parameters (so that customers can extend it and build their own provider) and check that DynamoDBPersistenceLayer is included in the exports - but we'll do it in separate PRs.

@dreamorosi dreamorosi merged commit a91df31 into aws-powertools:main Jun 12, 2023
@dreamorosi dreamorosi linked an issue Jun 12, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Changes that touch dependencies, e.g. Dependabot, etc. idempotency This item relates to the Idempotency Utility internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) parameters This item relates to the Parameters Utility size/L PRs between 100-499 LOC tests PRs that add or change tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: create API docs
2 participants