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

Add links to documentation for all commands #1767

Merged
merged 43 commits into from
Mar 22, 2019
Merged

Add links to documentation for all commands #1767

merged 43 commits into from
Mar 22, 2019

Conversation

J0
Copy link
Contributor

@J0 J0 commented Mar 22, 2019

Fix #1729 . It seems that there isn't any documentation for dvc daemon and dvc pkg so I am omitting it for now.

@J0 J0 changed the title [WIP]: Add links to documentation [WIP]: Add links to documentation for all commands Mar 22, 2019
@J0 J0 changed the title [WIP]: Add links to documentation for all commands Add links to documentation for all commands Mar 22, 2019
@J0
Copy link
Contributor Author

J0 commented Mar 22, 2019

I have added documentation links to all the commands that I could find through dvc --help. Do let me know if there are any edits required. I'm not too sure where the help message fordvc status is though( I wasn't able to find it in dvc/dvc/command/status.py. Would be great if someone could point me in the right direction-- if not then I'll do a search for it tomorrow

@shcheklein
Copy link
Member

This is great, @J0 ! Thanks. I suggest I add a dvc shortener for these links - something like help.dvc.org/commit -> dvc.org/doc/command-reference/commit. The main goal is to have a level of indirection we can control on the dvc.org website level. It's hard to always keep doc/* links up to date and I think it's not the best idea to depend on this. Give a bit of time to setup this redirect. What do you think? :)

@shcheklein
Copy link
Member

@J0 man.dvc.org is alive. Try this: https://man.dvc.org/metrics or https://man.dvc.org/metrics-show

@shcheklein
Copy link
Member

@J0 take a look at /dvc/command/data_sync.py for status command.

@shcheklein
Copy link
Member

@J0 also, let's add help messages for subcommands as well - for example - https://man.dvc.org/metrics-show for dvc metrics show.

dvc/command/move.py Outdated Show resolved Hide resolved
Copy link
Member

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff!

See my comments to fix small things.

@dmpetrov
Copy link
Member

It might be better to squash 32 commits into 1-10. Otherwise it might break our beautiful contributors-graph by creating a spike and changing the graph scale :)

$ git rebase -i HEAD~30
# follow instructions
$ git push -f

See: https://github.com/todotxt/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit

@shcheklein
Copy link
Member

@dmpetrov there is a button for that. @efiop will do Squash and merge when PR is ready. No need to redo the history in the PR itself.

@J0
Copy link
Contributor Author

J0 commented Mar 22, 2019

Hey @shcheklein sounds good to me -- I'll get to it in about 10 minutes :)

@shcheklein
Copy link
Member

@J0 no rush, thanks! I think we need to keep https:// prefix. There are some terminals that can make them clickable automatically. I'm not sure about man.dvc.org without the prefix. I would double check that.

@shcheklein
Copy link
Member

saying that, it looks like Mac OS terminal can recognize the shorter version - man.dvc.org/metrics ... what about other environments - @efiop @MrOutis @pared ?

Copy link
Member

@efiop efiop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! 🎉 A minor formatting issue down below.

@@ -26,7 +26,8 @@ def run(self):


def add_parser(subparsers, parent_parser):
ADD_HELP = "Add files/directories to dvc."
ADD_HELP = "Add files/directories to dvc. \n\
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's reformat all of these this way:

    ADD_HELP = (
        "Add files/directories to dvc. \n"
        "documentation: https://man.dvc.org/add"
    )

so it is unified everywhere and we don't mix \ into all of these.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok done

Copy link
Member

@efiop efiop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! 🎉

@efiop efiop merged commit 2ba657c into iterative:master Mar 22, 2019
@J0 J0 deleted the add_links_to_documentation branch March 22, 2019 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants