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 info about --no-scm mode (and link from get-started) #100

Closed
efiop opened this issue Oct 23, 2018 · 12 comments
Closed

user-guide: add info about --no-scm mode (and link from get-started) #100

efiop opened this issue Oct 23, 2018 · 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 Oct 23, 2018

Maybe worth making some portions of current get-started optional. Especially with the upcoming Hg support.

UPDATE: Skip to #100 (comment) for more details.

@shcheklein shcheklein added type: enhancement Something is not clear, small updates, improvement suggestions A: docs Area: user documentation (gatsby-theme-iterative) user-guide labels Mar 25, 2019
@shcheklein
Copy link
Member

shcheklein commented Mar 25, 2019

Should be part of the user-guide. A link in the get started should be enough. It's not a prevalent use case to distract attention on it.

@shcheklein shcheklein changed the title docs: add a simple get-started article/guide for --no-scm mode add a simple get-started article/guide for --no-scm mode Mar 25, 2019
@algomaster99
Copy link
Contributor

@shcheklein Is this issue about dvc init --no-scm command? How does it change the workflow? For example, dvc diff wouldn't work since the project won't have any commits.

@shcheklein
Copy link
Member

@algomaster99 yes, some commands won work. I would say, it a very low priority issue. Let's not focus on this one for now.

@dashohoxha
Copy link
Contributor

Working on a Katacoda scenario for this: https://katacoda.com/dvc/scenarios/data-management

@dashohoxha
Copy link
Contributor

I have created a lesson/tutorial about using DVC in --no-scm mode: https://katacoda.com/dvc/courses/basics/data
Is this sufficient to close the issue?

@shcheklein
Copy link
Member

@dashohoxha not enough, I believe. I think this ticked should be implemented as a note/mention in one of the introductory user guide sections (that are still not implemented and probably will be taken from the Understanding DVC). I can imagine there can be a section named "How it works" that can have a page inside "DVC and Git" - just an example to give you some sense. We should come with better titles for this.

Bottom line, I believe it'll be closed as part of #425, and #144, and #550.

@jorgeorpinel jorgeorpinel changed the title add a simple get-started article/guide for --no-scm mode user-guide: add info about --no-scm mode (and link from get-started) Nov 27, 2019
@jorgeorpinel
Copy link
Contributor

Do we still want to note this in Get Started? Seems to me we no longer want to do this, in order to keep the start guide as lean and non-distracting as possible. The option is explained in https://dvc.org/doc/command-reference/init and mentioned in a few other refs already (e.g. in add and config) so should we close this?

@efiop
Copy link
Contributor Author

efiop commented Jul 13, 2020

@jorgeorpinel We do have the cmdreference, but we need some user-guide article about it that will describe what and how it could be used for(e.g. docker, deployment etc). I wouldn't close it for now.

@jorgeorpinel
Copy link
Contributor

Maybe a "How To use init --no-scm effectively"? Rel #899

@efiop
Copy link
Contributor Author

efiop commented Jul 13, 2020

@jorgeorpinel I don't quite understand what is effectiveness in --no-scm though? how-tos seem like simple recipes to me, so in that particular format they would be a multiple of articles (e.g. using data in docker). That's a great idea, but i feel like it also needs a user-guide article to describe what it is about and how it works and then maybe reference all the how-tos you could use --no-scm in.

@jorgeorpinel
Copy link
Contributor

The point was it could be a How To guide (the title can be anything), since we have that ticket already.

but i feel like it also needs a user-guide article to describe what it is about and how it works and then maybe reference all the how-tos

Fair enough.

@shcheklein
Copy link
Member

Closing this. We def would like to add articles like "Packaging DVC artifacts into Docker", "DVC in production", etc ... but we have info regarding --no-scm itself. I don't think we want a whole separate section on it.

@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

No branches or pull requests

6 participants