-
Notifications
You must be signed in to change notification settings - Fork 394
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
document env vars #5030
document env vars #5030
Conversation
Open to doing this differently or combining with #5012, but seems like we need somewhere to document all DVC env vars |
<abbr>experiment</abbr>. | ||
- `DVC_EXP_GIT_REMOTE`: The name of the Git remote to use in `DVC_EXP_AUTO_PUSH` | ||
(for example, `origin`). | ||
- `DVC_NO_ANALYTICS`: If `true`, disables |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- `DVC_NO_ANALYTICS`: If `true`, disables | |
- `DVC_NO_ANALYTICS`: If set, disables |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@skshetry Why is it your preference? I kind of see the logic, but part of me feels it's better to give an example of a valid value for the env var.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We used DVC_NO_ANALYTICS
to take effect on any value because with this envvar, you only want to disable analytics. And, tbh with these envvars, I can never figure out if it should be set as 0/1/true/yes/no.
I am fine with showing an example. I wasn't sure if this was a reference or not. I'm fine with what you have.
Are we ready to merge this? |
I was waiting to align on the related issues linked above. Is it worthwhile to document |
Also, if it absorbs #5012, let me do one more pass to maybe clarify and incorporate some of the suggestions there from @natikgadzhi. |
Dropped |
This adds a page with DVC environment variables. It doesn't document all of them since some seem intended to be private, but it documents all those that are mentioned elsewhere in the docs. I don't think this is the ideal place for the page, but I don't want to bog this down in a major reorg of docs like suggested in #4381.
Related:
DVC_STUDIO_URL
andDVC_STUDIO_TOKEN
env variablesgit #5012