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

#148 - Add documentation for env vars #152

Merged
merged 10 commits into from
Sep 13, 2023

Conversation

trizin
Copy link
Contributor

@trizin trizin commented Sep 8, 2023

Fixes #148

Changes proposed in this PR:

  • Add documentation for env vars

@trizin trizin linked an issue Sep 8, 2023 that may be closed by this pull request
@trizin trizin marked this pull request as ready for review September 8, 2023 10:41
@trizin trizin requested a review from trentmc September 8, 2023 10:44
@trizin trizin changed the title Add documentation for env vars #148 - Add documentation for env vars Sep 8, 2023
@trizin trizin self-assigned this Sep 8, 2023
@@ -0,0 +1,31 @@
# Environment Variables
Copy link
Member

Choose a reason for hiding this comment

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

Feedback:

  1. Please call this file envvars.md, not env-vars.md. Less annoying for us to work with.

  2. Please link to this from README.md, in the bottom section.

  3. Please link to this from each agent-specific README; from the backend-dev README; and from the frontend-dev README. Keep it concise.

  4. There actually is a bit of documentation on the filter envvars, at the bottom of subgraph.md. To reconcile (and avoid DRY): in subgraph.md, just mention the 4 envvars, and then link to envvars.md.

@trizin trizin requested a review from trentmc September 13, 2023 13:31
@trizin trizin merged commit 2651998 into main Sep 13, 2023
5 checks passed
@trizin trizin deleted the issue148-properly-document-env-vars-used-in-pdr-backend branch September 13, 2023 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Properly document env vars used in pdr-backend
2 participants