-
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
how-to: further improvements #1976
Conversation
jorgeorpinel
commented
Nov 27, 2020
•
edited
Loading
edited
- Put Merge Conflicts in
- Rename Update Tracked Files->Data
- Update SEO info.
- Add corresponding redirects
- Minor copy edits
…->Data, add redirects
"add-deps-or-outs-to-a-stage" | ||
"update-tracked-data", | ||
"add-deps-or-outs-to-a-stage", | ||
"merge-conflicts" | ||
] | ||
}, | ||
"setup-google-drive-remote", |
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.
Feels like this lonely guide could also be a how-to, at least until we expand on all the other types and figure out where to put them.
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.
Putting "how to" before the title doesn't make it a how-to, the content has to be short recipes to address specific problems. The ones you mention are 50% + explanation (and not very short), the remaining part is examples. That doesn't really count (:
How to Setup Remotes also includes some explanation, but mostly how-to stuff.
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.
How to Setup Remotes also includes some explanation, but mostly how-to stuff.
I guess you could argue it's a lot of explanation actually. Ok, let's leave it as a guide!
"^/doc/user-guide/how-to/update-tracked-files$ /doc/user-guide/how-to/update-tracked-data", | ||
"^/doc/user-guide/merge-conflicts$ /doc/user-guide/how-to/merge-conflicts", |
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.
Note for self:
- Remember to request re-indexing of these 2 new URLs in search.google.com/u/1/search-console
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.
Oops, can't right now: https://support.google.com/webmasters/answer/6211453#url_inspection
Will try in a few days...
Hmmm there was a problem deploying this it seems... |
Strange because the last test here passed: https://app.circleci.com/pipelines/github/iterative/dvc.org/6808/workflows/6f5d646f-c323-4ad5-91ba-9ff01bbd9604/jobs/6864 But the build failed: https://dashboard.heroku.com/apps/dvc-org/activity/builds/a2ce7bc5-3334-4140-b68d-7f8a0f700f8a With
|
Fixing in #1977 |