Skip to content

docs: main page updates around support #1133

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

Merged
merged 2 commits into from
Oct 25, 2022

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Oct 25, 2022

Description of your changes

As described in #1132 there are some changes related to how to support the project that were made in the Python version of Powertools and that needed to be replicated here. This PR addresses that action item.

This PR also cover some minor housekeeping in 3 more sections of the docs.

How to verify this change

You can verify this change by running docs-buildDockerImage & docs-runLocalDocker while in the root folder (requires Docker).

Or check the screenshots provided below (only for main page):

Screenshot 2022-10-25 at 07 40 37

Screenshot 2022-10-25 at 07 42 35

Screenshot 2022-10-25 at 07 43 13

Related issues, RFCs

Issue number: #1132

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

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
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

Breaking change checklist

N/A


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

@dreamorosi dreamorosi self-assigned this Oct 25, 2022
@dreamorosi dreamorosi linked an issue Oct 25, 2022 that may be closed by this pull request
2 tasks
@dreamorosi dreamorosi requested a review from saragerion October 25, 2022 05:49
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 25, 2022
@heitorlessa
Copy link
Contributor

reading...

Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

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

LGTM, only one part to remove (leftover from Python docs)

Co-authored-by: Heitor Lessa <[email protected]>
@dreamorosi
Copy link
Contributor Author

@heitorlessa thank you for the review & for spotting the leftover line about pydantic.

I have committed your suggestion!

@dreamorosi dreamorosi merged commit c25279c into main Oct 25, 2022
@dreamorosi dreamorosi deleted the 1132-maintenance-clarify-ways-to-support-pt-in-docs branch October 25, 2022 11:09
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: Clarify ways to support PT in docs
2 participants