-
Notifications
You must be signed in to change notification settings - Fork 394
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
guide: reorder how-tos and copy edits; expand on adding existing dependencies to a stage #1914
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bunch of copy edits above, and a couple more relevant comments ☝️
Thanks
perhttps://github.com//pull/1914#pullrequestreview-538204006 etc.
@@ -1,76 +1,72 @@ | |||
# Updating Tracked Files | |||
# How to Update Tracked Files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Files or Data - in some case we use Data, in some cases Files. is it okay?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Data is better but this is a pre-existing use case and renaming it is a bit out-of-scope, esp. since it requires a redirect.
TBH I want to move other guides into this section: Merge Conflicts and Setup a Google Drive Remote for starters (also need redirects). So should we do all that in a separate PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So should we do all that in a separate PR?
yes, def not this PR!
Setup a Google Drive Remote
this should part of a bigger section that has a page per remote type. It's not How to
Merge Conflicts
It can be probably part of the How to
indeed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Setup a Google Drive Remote...
should part of a bigger section that has a page per remote type. It's not How to
I think it's definitely "how-to" material, even if we put that remote config section somewhere else. I'll let it be for now then.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can put pretty much anything into How to this way ... How to manage external data, How to contribute, How to optimize deal with large data, How to run on Windows, etc ...
I think there should be something else that defines this section - closer to FAQ? some specific workflow questions?
In case of Google Drive - we'll have one page per remote. Even size in this case makes a bad fit. Eventually it might become bigger than everything else.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Continued in #1976
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great to me, just a few comments left - I would simplify the title.
Let's incorporate these changes to #1913 and close this PR.This PR will now also incorporate #1913 (review)
Fixes #460 (How to add dependencies to a stage without re-running it)