Create documentation for .env file #114
Merged
Conversation
This file contains hidden or 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
johnwalz97
approved these changes
Jul 13, 2023
Co-authored-by: John Halz <johnwalz97@gmail.com>
@johnwalz97 Makes sense, I think it makes the instructions more clear. Thanks for your help! |
nrichers
reviewed
Jul 13, 2023
| %load_ext dotenv | ||
| %dotenv dev.env | ||
| \``` | ||
|
|
There was a problem hiding this comment.
Would it maybe make sense to add an example that shows what the completed notebook snippet looks like? This way, people have more of an example they can compare their own to. I think we could likely just grab something from the earlier version of John's notebook.
There was a problem hiding this comment.
I added the snippet from this notebook as an example: https://docs.validmind.ai/notebooks/how_to/implementing_custom_tests.html
There was a problem hiding this comment.
Thank you, that looks good.
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
nrichers
approved these changes
Jul 13, 2023
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.
Internal Notes for Reviewers
Created documentation for storing credentials in a .env file, since the 'before you begin' section updates for this pull request use inline credentials. Once this PR is approved, the notebooks need to be updated to link to the new documentation.
External Release Notes
New documentation for storing project credentials in a '.env' file. This documentation explains how to modify notebooks to do this and why it is a best practice for security.