Skip to content

Docs: document all supported environment variables settings #350

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 Dec 27, 2021 · 4 comments
Closed

Docs: document all supported environment variables settings #350

saragerion opened this issue Dec 27, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation duplicate This issue is a duplicate of an existing one good-first-issue Something that is suitable for those who want to start contributing rejected This is something we will not be working on. At least, not in the measurable future

Comments

@saragerion
Copy link
Contributor

saragerion commented Dec 27, 2021

Description of the feature request

The library's utilities allow the configuration of settings via env variables or constructor.
It would be helpful to create a documentation section with a table for each utility to describe what variables can be used, and if they overlap with other TS utilities or not (for example: POWERTOOLS_SERVICE_NAME, POWERTOOLS_TRACE_ENABLED, ...)

Problem statement

Developers can figure it out by looking at the source code, but the variables are undocumented.

Summary of the feature

N/A

Code examples

N/A

Benefits for you and the wider AWS community

N/A

Describe alternatives you've considered

N/A

Additional context

N/A

Related issues, RFCs

N/A

@saragerion saragerion added this to the production-ready-release milestone Dec 27, 2021
@saragerion
Copy link
Contributor Author

saragerion commented Dec 27, 2021

Note: There is already a section with a table in the homepage, with all variables.
I do think that there is still an opportunity to document the behaviour / functionality of the library for each variable in dedicated sessions.

@dreamorosi dreamorosi added all documentation Improvements or additions to documentation labels Dec 27, 2021
@dreamorosi dreamorosi added the good-first-issue Something that is suitable for those who want to start contributing label Feb 21, 2022
@saragerion saragerion removed this from the production-ready-release milestone May 24, 2022
@saragerion
Copy link
Contributor Author

Example of improvement, for boolean variables, document if: does it accept 0,1? TRUE, FALSE? true, false?

@saragerion
Copy link
Contributor Author

Closing as this is a duplicate of #724

@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 added completed This item is complete and has been merged/shipped duplicate This issue is a duplicate of an existing one rejected This is something we will not be working on. At least, not in the measurable future and removed completed This item is complete and has been merged/shipped labels Nov 14, 2022
@dreamorosi dreamorosi changed the title all: document all supported environment variables settings Docs: document all supported environment variables settings Nov 14, 2022
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 duplicate This issue is a duplicate of an existing one good-first-issue Something that is suitable for those who want to start contributing rejected This is something we will not be working on. At least, not in the measurable future
Projects
None yet
Development

No branches or pull requests

2 participants