docs: add troubleshooting section

[Nr18]

Issue #, if available:

Description of changes:

Add a troubleshooting section in the CONTRIBUTING.md

Checklist

• Meet tenets criteria
• Update tests
• Update docs
• PR title follows conventional commit semantics

Breaking change checklist

RFC issue #:

• Migration process documented
• Implement 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.

[codecov-commenter]

Codecov Report

Merging #151 into develop will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           develop      #151   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           24        24           
  Lines          705       705           
  Branches        68        68           
=========================================
  Hits           705       705           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 319c363...c6e7d06. Read the comment docs.

[heitorlessa]

Let me know if I misunderstood the guidance - I suspect it's missing a resolution besides naming the problem. I suspect you were also trying to run make docs-api-local

[heitorlessa]

Yes, unless you somehow (on purpose, pure evil) change directory and then use poetry shell to run pdoc3 haha

…

On Tue, 1 Sep 2020 at 13:02, Joris Conijn ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In CONTRIBUTING.md <#151 (comment)> : > @@ -69,6 +69,9 @@ ***@***.*** with any additional questions or comments. ## Security issue notifications If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. +## Troubleshooting + +* The local **API reference** throws a `Module aws_lambda_powertools not found` error when an exception is raised in the code-base, when you run `poetry run pdoc --pdf aws_lambda_powertools` the exception is shown. Ah nice I added the make dev as a solution as well, the pdoc3 path can't be wrong anymore since we run everything in a poetry shell right? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#151 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBGXCBGUJQ4R433OH5LSDTIEFANCNFSM4QPX34CQ> .

[heitorlessa]

Thanks a lot for adding the troubleshooting section - It'll help us provide more prescriptive guidance when hitting these pesky issues ;)