add env-vars documentation #42
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| **Temporary (for the current session):** | ||
|
|
||
| ```bash | ||
| export VARIABLE_NAME=value |
There was a problem hiding this comment.
This example could be changed to one more topical to cargo mommy.
| Add the export command to your shell profile file (e.g., ~/.bashrc, ~/.zshrc). | ||
|
|
||
| ```bash | ||
| echo 'export VARIABLE_NAME=value' >> ~/.bashrc |
There was a problem hiding this comment.
Suggested change
| echo 'export VARIABLE_NAME=value' >> ~/.bashrc | |
| echo 'export VARIABLE_NAME=value' >> ~/.bashrc |
ditto.
Comment on lines
+17
to
+18
| **Permanent (across sessions):** | ||
| Add the export command to your shell profile file (e.g., ~/.bashrc, ~/.zshrc). |
There was a problem hiding this comment.
This doesn't explain why it makes this change permanent.
|
|
||
| ## Environment Variables Overview | ||
|
|
||
| Environment variables are dynamic-named values that affect the processes running on an operating system. They are used to store configuration settings, paths, and other important information. Here's a step-by-step guide on how to work with environment variables. |
There was a problem hiding this comment.
Suggested change
| Environment variables are dynamic-named values that affect the processes running on an operating system. They are used to store configuration settings, paths, and other important information. Here's a step-by-step guide on how to work with environment variables. | |
| Environment variables are dynamically-named values that affect the processes running on an operating system. They are used to store configuration settings, paths, and other important information. Here's a step-by-step guide on how to work with environment variables. |
There was a problem hiding this comment.
However, in general, these docs don't need to explain this in a general way. Mommy needs an explanation for cargo mommy in particular!
Comment on lines
+41
to
+45
| # Example: Adding a custom directory to the PATH | ||
| export PATH=$PATH:/path/to/custom/directory | ||
|
|
||
| # Example: Setting a default editor | ||
| export EDITOR=vim |
Comment on lines
+63
to
+64
| export NODE_ENV=development | ||
| export PORT=3000 |
Comment on lines
+70
to
+71
| export PYTHONPATH=/path/to/project | ||
| export FLASK_ENV=development |
Comment on lines
+79
to
+89
| ## 5. Security Considerations: | ||
|
|
||
| **Avoid storing sensitive information directly in environment variables.** | ||
| **On Windows, be cautious about using environment variables in scripts as they can be easily accessed.** | ||
|
|
||
| ## 6. Best Practices: | ||
|
|
||
| **Use uppercase letters and underscores for variable names (e.g., DATABASE_URL).** | ||
| **Document your environment variables in a README file for better collaboration.** | ||
|
|
||
| By following these steps and examples, you can effectively manage and use environment variables in various scenarios, making your development environment more flexible and scalable. |
There was a problem hiding this comment.
Irrelevant.
Suggested change
| ## 5. Security Considerations: | |
| **Avoid storing sensitive information directly in environment variables.** | |
| **On Windows, be cautious about using environment variables in scripts as they can be easily accessed.** | |
| ## 6. Best Practices: | |
| **Use uppercase letters and underscores for variable names (e.g., DATABASE_URL).** | |
| **Document your environment variables in a README file for better collaboration.** | |
| By following these steps and examples, you can effectively manage and use environment variables in various scenarios, making your development environment more flexible and scalable. |
There was a problem hiding this comment.
Alternately, consider a heading like
## 5. Consent Considerations:
Comment on lines
+74
to
+77
| ## 4. Windows Considerations: | ||
|
|
||
| **On Windows, environment variables can be set through the System Properties or using PowerShell.** | ||
| **To persistently modify environment variables on Windows, use the [System Properties](https://www.computerhope.com/issues/ch000549.htm) window. This requires administrative privileges.** |
There was a problem hiding this comment.
This should explain the persistence of PowerShell's env vars instead.
|
This will somewhat duplicate the effort of, and has conceptual conflicts, respectively, with |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change resolves #31 by adding documentation for env-vars.
Signed-off-by: Jason Zubiate [email protected]