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

user-guide: add "folders" way of experimentation #159

Closed
Tracked by #156
efiop opened this issue Jan 19, 2019 · 12 comments
Closed
Tracked by #156

user-guide: add "folders" way of experimentation #159

efiop opened this issue Jan 19, 2019 · 12 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@efiop
Copy link
Contributor

efiop commented Jan 19, 2019

Currently, we only mention branches as a way of experimentation (in Get Started), but it is not ideal and we've seen users use folders as an alternative. Need to mention it in our docs.

@efiop efiop added the A: docs Area: user documentation (gatsby-theme-iterative) label Jan 19, 2019
@shcheklein shcheklein changed the title docs: get started: add "folders" way of experimentation get started: add "folders" way of experimentation Mar 25, 2019
@shcheklein shcheklein added type: enhancement Something is not clear, small updates, improvement suggestions user-guide labels Mar 25, 2019
@shcheklein
Copy link
Member

I think we should keep a single way in get started, mention other ways in user-guide and make a link to it. I'm switching get started to use tags now to avoid merging and other complicated ugly stuff.

@shcheklein shcheklein changed the title get started: add "folders" way of experimentation add "folders" way of experimentation in user guide Mar 25, 2019
@dashohoxha
Copy link
Contributor

@shcheklein
Copy link
Member

👍 @dashohoxha it can be a more general Managing Experiments use case or user guide section. It can include different approaches - folders, tags, branches, commits, etc.

@dashohoxha
Copy link
Contributor

Related: iterative/dvc#2324

@dashohoxha
Copy link
Contributor

The last step of this lesson mentions something about using different folders for different pipelines:
https://katacoda.com/dvc/courses/basics/pipelines
But I am not sure if this is enough to close this issue.

@efiop
Copy link
Contributor Author

efiop commented Oct 9, 2019

@dashohoxha Feels like it would be suitable to describe that more formally, hence why I was mentioning "user guide" and not "get-started" or "tutorial".

@dashohoxha
Copy link
Contributor

@efiop Right. But some things are better explained with a working example. It may also be easier for the users to understand it. And an example can also be complemented by formal and generalized descriptions.

@dashohoxha dashohoxha mentioned this issue Oct 25, 2019
10 tasks
@jorgeorpinel jorgeorpinel changed the title add "folders" way of experimentation in user guide user-guide: add "folders" way of experimentation Nov 27, 2019
@jorgeorpinel
Copy link
Contributor

general Managing Experiments use case or user guide section. It can include different approaches - folders, tags, branches, commits, etc.

I reviewed all docs and he term "experiment" is not mentioned in the User Guide at all, and only once in Use Cases (in Shared Development Server). Otherwise we mainly talk about experiments in command references and tutorials. So it seems this new Managing Experiments is still a valid enhancement. Please note we should use the term "directory" instead of "folder" though.

@dashohoxha
Copy link
Contributor

So it seems this new Managing Experiments is still a valid enhancement.

@jorgeorpinel are you working on it?
I am asking so that we don't make a conflict with #816.

@jorgeorpinel
Copy link
Contributor

I'm not. I was just reviewing the validity of some older issues.
But if #816 addresses this, maybe one of the 2 should be closed?

@dashohoxha
Copy link
Contributor

But if #816 addresses this, maybe one of the 2 should be closed?

I think that they overlap but are not quite the same. We can close them both with this PR: #828

@jorgeorpinel
Copy link
Contributor

Closing in favor of #816

@iesahin iesahin added the C: guide Content of /doc/user-guide label Oct 21, 2021
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 type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants