Dvc: TLDR for DVC [https://github.com/tldr-pages/tldr]

Created on 12 Jul 2020  路  5Comments  路  Source: iterative/dvc

Can we think of creating TLDR for dvc and all it's sub commands??

TLDR cmd:
Given a command tldr gives list of it's comman usage pattern to get started quick.

For example: GIT _which is closest to dvc_:

~ tldr git

git

Distributed version control system.
More information: <https://git-scm.com/>.

- Check the Git version:
    git --version

- Call general help:
    git --help

- Call help on a command:
    git help command

- Execute Git command:
    git command
 ~ tldr git pull

git pull

Fetch branch from a remote repository and merge it to local repository.
More information: <https://git-scm.com/docs/git-pull>.

- Download changes from default remote repository and merge it:
    git pull

- Download changes from default remote repository and use fast forward:
    git pull --rebase

- Download changes from given remote repository and branch, then merge them into HEAD:
    git pull remote_name branch
~ tldr git add

git add

Adds changed files to the index.
More information: <https://git-scm.com/docs/git-add>.

- Add a file to the index:
    git add path/to/file

- Add all files (tracked and untracked):
    git add -A

- Only add already tracked files:
    git add -u

- Also add ignored files:
    git add -f

- Interactively stage parts of files:
    git add -p

- Interactively stage parts of a given file:
    git add -p path/to/file

- Interactively stage a file:
    git add -i
feature request p3-nice-to-have

Most helpful comment

@efiop

Here is linked pull request: https://github.com/tldr-pages/tldr/pull/4225
I have started work on it. Completed creating pages for 13 sub commands.
I still have like 33 more to go 馃槣 .

All 5 comments

Happy to give it a shot, if makes sense. :)

@PuneethaPai Looks very cool! Sure, please feel free to give it a shot! :pray:

@efiop

Here is linked pull request: https://github.com/tldr-pages/tldr/pull/4225
I have started work on it. Completed creating pages for 13 sub commands.
I still have like 33 more to go 馃槣 .

@PuneethaPai it'll be very hard to keep this up to date? any chance we can generate these pages? similar as we do for autocomplete?

How tldr works is like we have to generate cmd.md files keeping in mind first time user.
What I can think of for automation is, we can go up to generating these files and raising Pull Request.
After which we/they can quickly validate and merge it.

Let me know if there are better ways. We still need to figure out how to generate the pages.

Was this page helpful?
0 / 5 - 0 ratings