Skip to content

Docs: Logger documentation #130

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

Closed
saragerion opened this issue Jul 23, 2021 · 4 comments · Fixed by #293
Closed

Docs: Logger documentation #130

saragerion opened this issue Jul 23, 2021 · 4 comments · Fixed by #293
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation logger This item relates to the Logger Utility
Milestone

Comments

@saragerion
Copy link
Contributor

Description of the feature request

Problem statement
N/A.

Summary of the feature
Documentation for the Logger library:
https://awslabs.github.io/aws-lambda-powertools-python/core/logger/

Code examples
https://github.com/awslabs/aws-lambda-powertools-python/tree/develop/docs
https://github.com/awslabs/aws-lambda-powertools-python/blob/develop/README.md

Benefits for you and the wider AWS community
Understand how to use the library and speed up their adoption.

Describe alternatives you've considered

N/A

Additional context

N/A

Related issues, RFCs

#24

@saragerion saragerion added this to the beta-release milestone Jul 23, 2021
@dreamorosi
Copy link
Contributor

Hi Sara, I have looked into the docs for the Python version and the workflow seems to be the following:

  • Once a push is made on branch develop, this workflow is executed.
  • The workflow builds the docs (folder docs) which end up in a dedicated branch called gh-pages.
  • The workflow also does additional actions around redirections, I guess related to the newer version.

@heitorlessa does this look right?

@saragerion are we fine with using MKDocs and the same kind of workflow?

@dreamorosi dreamorosi added the documentation Improvements or additions to documentation label Jul 23, 2021
@saragerion saragerion self-assigned this Jul 23, 2021
@saragerion
Copy link
Contributor Author

Thanks for the breakdown @dreamorosi 👏
I'd say yes let's use the same library/workflow as much as possible for the scope of this beta launch.

@dreamorosi
Copy link
Contributor

dreamorosi commented Jul 30, 2021

Created a working branch with the minimal structure of the documentation adapted for Typescript. Currently has only core modules (pages mostly empty) and analytics already wired for this language. You can run it locally with npm run docs-local-docker.

@dreamorosi dreamorosi added the logger This item relates to the Logger Utility label Jul 30, 2021
@saragerion saragerion linked a pull request Dec 13, 2021 that will close this issue
10 tasks
@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi changed the title logger: documentation Docs: Logger documentation Nov 14, 2022
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation logger This item relates to the Logger Utility
Projects
None yet
2 participants