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

fetch: review sample command output #551

Closed
jorgeorpinel opened this issue Aug 11, 2019 · 8 comments
Closed

fetch: review sample command output #551

jorgeorpinel opened this issue Aug 11, 2019 · 8 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) duplicate This issue or pull request already exists. good first issue Good for newcomers 🐛 type: bug Something isn't working. type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

For example from static/docs/commands-reference/fetch.md line 204+:

$ dvc checkout
Checking out '{'scheme': 'local', 'path': '.../example-get-started/model.pkl'}' with cache '3863d0e317dee0a55c4e59d2ec0eef33'.
...

Extracted from #549 (review)

@jorgeorpinel
Copy link
Contributor Author

The effort for this may be too great. Perhaps we should rather think of a way that will be sustainable in the future to make sure all our code and console examples remain valid as DVC changes. For example generating them all from scripts in a separate docs-code-examples-dev Git repo, similar to https://github.com/iterative/example-repos-dev ?

@shcheklein
Copy link
Member

I would just create a small tickets from time to time to update it. I don't think we need a special machinery around this. At least now. Too much effort.

@shcheklein shcheklein changed the title docs: review correctness of all? code blocks in examples, particularly cmd. refs. docs: review fetch examples output and similar Aug 12, 2019
@shcheklein
Copy link
Member

As part of this one, I would just grep "{scheme ...}" messages and replace them with human readable versions. It should be straightforward and should not require running all these examples, I hope.

@shcheklein shcheklein added 🐛 type: bug Something isn't working. command-reference A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions good first issue Good for newcomers labels Aug 12, 2019
@shcheklein shcheklein changed the title docs: review fetch examples output and similar review fetch examples output and similar Aug 12, 2019
@jorgeorpinel
Copy link
Contributor Author

$ dvc checkout
Checking out '{'scheme': ...

was just an example. I meant absolutely all the ```dvc code block examples, basically. There's 450 :/

@shcheklein
Copy link
Member

Yep, I +1 on that it's too much of a scope to update them. But also I'm not sure we need some very specific mechanism to keep them up-to-date. At least for now. Let's just do the best we can when we update docs.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Aug 13, 2019

Fair enough! Hopefully we can count on users reporting any problems via issues.

@shcheklein
Copy link
Member

I meant - let's open this particular one open :) Just fix fetch examples. And may be similar outputs around.

@jorgeorpinel jorgeorpinel changed the title review fetch examples output and similar fetch: review sample command output Oct 25, 2019
@jorgeorpinel
Copy link
Contributor Author

Closing as dupe of #614 (comment).

@jorgeorpinel jorgeorpinel added the duplicate This issue or pull request already exists. label Jan 14, 2020
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) duplicate This issue or pull request already exists. good first issue Good for newcomers 🐛 type: bug Something isn't working. type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

No branches or pull requests

2 participants