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

document env vars #5030

Merged
merged 2 commits into from
Dec 12, 2023
Merged

document env vars #5030

merged 2 commits into from
Dec 12, 2023

Conversation

dberenbaum
Copy link
Collaborator

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:

@dberenbaum
Copy link
Collaborator Author

Open to doing this differently or combining with #5012, but seems like we need somewhere to document all DVC env vars

@shcheklein shcheklein temporarily deployed to dvc-org-env-vars-hww9vgxjxu7b2 December 4, 2023 20:46 Inactive
Copy link
Contributor

github-actions bot commented Dec 4, 2023

Link Check Report

There were no links to check!

<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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- `DVC_NO_ANALYTICS`: If `true`, disables
- `DVC_NO_ANALYTICS`: If set, disables

Copy link
Collaborator Author

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.

Copy link
Member

@skshetry skshetry Dec 12, 2023

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.

@shcheklein
Copy link
Member

Are we ready to merge this?

@shcheklein shcheklein added C: guide Content of /doc/user-guide A: docs Area: user documentation (gatsby-theme-iterative) labels Dec 9, 2023
@dberenbaum
Copy link
Collaborator Author

I was waiting to align on the related issues linked above.

Is it worthwhile to document DVC_EXP_AUTO_PUSH in its current state? I initially drafted this PR in part as a precursor to #5035, but I'm not sure we actually want to push people to use this env var. I lean towards dropping it from this PR for now and then I think we could merge.

@dberenbaum
Copy link
Collaborator Author

Also, if it absorbs #5012, let me do one more pass to maybe clarify and incorporate some of the suggestions there from @natikgadzhi.

@shcheklein shcheklein temporarily deployed to dvc-org-env-vars-hww9vgxjxu7b2 December 12, 2023 15:52 Inactive
@dberenbaum
Copy link
Collaborator Author

Dropped DVC_EXP_AUTO_PUSH and DVC_EXP_GIT_REMOTE to keep this simple. Merging now.

@dberenbaum dberenbaum merged commit ad38948 into main Dec 12, 2023
5 checks passed
@dberenbaum dberenbaum deleted the env-vars branch December 12, 2023 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants