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

cmd ref: review description of init and related commands (per --subdir) #1039

Closed
2 tasks
jorgeorpinel opened this issue Mar 9, 2020 · 1 comment
Closed
2 tasks
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference type: discussion Requires active participation to reach a conclusion. type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Mar 9, 2020

Extracted from #1022 (review)

  • Update sync commands per "data sync commands without specific target: Stages for subdirs will not be gathered"
  • May be we should consider moving some part to the User Guide.

Discussion part:

I also think (already discussed with Ivan) that the result here is a little too long. We went from 2 paragraphs to 21 plus block codes. It's not necessarily a problem because all of this info is valuable, but I think in part it can be summarized at least a little, and possibly extract these advanced cases into the user guide (as suggested above). We even state that they are "rare", so I'm not sure it's worth explaining them in detail in the description of this cmd ref. Another option is to make them into examples and keep the direct links from the description. Food for thought.

@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions type: discussion Requires active participation to reach a conclusion. A: docs Area: user documentation (gatsby-theme-iterative) labels Mar 9, 2020
@jorgeorpinel
Copy link
Contributor Author

We should also review the text of what the --subdir and --no-scm options do (motivation) as well as examples because they may be incorrect as explained in iterative/dvc#2901 (comment).

@iesahin iesahin added the C: ref Content of /doc/*-reference label Oct 21, 2021
@dberenbaum dberenbaum closed this as not planned Won't fix, can't repro, duplicate, stale Oct 17, 2023
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: ref Content of /doc/*-reference type: discussion Requires active participation to reach a conclusion. type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

No branches or pull requests

3 participants