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

how-to: further improvements #1976

Merged
merged 2 commits into from
Nov 27, 2020
Merged

how-to: further improvements #1976

merged 2 commits into from
Nov 27, 2020

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented Nov 27, 2020

Continues #1914 (review)

  • Put Merge Conflicts in
  • Rename Update Tracked Files->Data
  • Update SEO info.
  • Add corresponding redirects
  • Minor copy edits

"add-deps-or-outs-to-a-stage"
"update-tracked-data",
"add-deps-or-outs-to-a-stage",
"merge-conflicts"
]
},
"setup-google-drive-remote",
Copy link
Contributor Author

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.

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Nov 28, 2020

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.

Copy link
Contributor Author

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!

Comment on lines +33 to +34
"^/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",
Copy link
Contributor Author

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

Copy link
Contributor Author

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...

@jorgeorpinel jorgeorpinel merged commit 0faedc9 into master Nov 27, 2020
@jorgeorpinel
Copy link
Contributor Author

Hmmm there was a problem deploying this it seems...

image

https://dvc.org/doc/user-guide/how-to/stop-tracking-data

@jorgeorpinel
Copy link
Contributor Author

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

       $ gatsby build
       success open and validate gatsby-configs - 0.388s
...
       success createSchemaCustomization - 0.539s
error Error processing Markdown file /tmp/build_b4f41058_/content/docs/user-guide/how-to/add-deps-or-outs-to-a-stage.md:
      can not read a block mapping entry; a multiline key may not be an implicit key at line 5, column 1:
    
    ^
       not finished source and transform nodes - 1.041s
error Command failed with exit code 1.
       info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
------------------------
...

@jorgeorpinel
Copy link
Contributor Author

Fixing in #1977

shcheklein pushed a commit that referenced this pull request Nov 28, 2020
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.

2 participants