doc: regular updates (late Jan) #931

jorgeorpinel · 2020-01-19T02:43:37Z

Re-closes docs: add emoji symbols to improve docs #855
Closes cmd ref: link from remote add to remote modify #809
Closes term: word-emphasizing best practice? #686
Closes cmd ref: document dir support for import-url and get-url #841
Closes document that hooks don't act in a non-DVC branch #506
Other misc. stuff, as usual
Closes tutorials: replace dvc pull example in deep tut #946

including use of emojis per #855

per #809

for #686

for #841

public/static/docs/command-reference/import-url.md

public/static/docs/command-reference/get.md

in prep for #506

…nches per #506 (comment)

public/static/docs/command-reference/checkout.md

install, checkout, commit, repro, and push per #931 (review)

fix formatting of user-guide/contributing

rel: iterative/dvc/issues/3182

ref: iterative/dvc/issues/3182

review "Nothing to reproduce." output samples (after `dvc repro`) rel: #938

per #931 (comment)

per #931 (review)

public/static/docs/install/macos.md

per #931 (comment)

per iterative/dvc/pull/3277 and precursor to merging DVC repo term into DVC project (glossary)

for iterative/dvc/pull/3277

per #931 (review)

from #931 (review)

shcheklein · 2020-02-04T01:57:58Z

public/static/docs/command-reference/get-url.md

-data files.
+<!-- Separate MD quote: -->
+
+> See `dvc get` to download data/model files or directories from other <abbr>DVC


three notes in a raw - smells bad )

Agree. And import-url has 4 in a row... Will think about this ⏳

Addressed in 1551b4b (part of #966).

shcheklein · 2020-02-04T01:59:08Z

public/static/docs/command-reference/get.md

+target to be downloaded within the source repository at `url`. It can point to
+any file or directory in there, including <abbr>outputs</abbr> tracked by DVC,
+as well as files tracked by Git. Note that for DVC repos, the target should be
+found in one of the [DVC-files](/doc/user-guide/dvc-file-format) pf the project.


Addressed in #966

shcheklein

few typos, few unaddressed comments ... merging this anyway to prevent it from growing again, each review takes too much of my time since there are too many changes happen to all files at once

per #931 (review)

jorgeorpinel · 2020-02-04T02:15:16Z

few typos

Other than "pf"? (Addressed)

unaddressed comments

Moving them to #966

merging this anyway to prevent it from growing again

Thank you!

per #931 (comment)

per #931 (review)

jorgeorpinel · 2020-02-07T02:03:43Z

public/static/docs/glossary.js

    {
      name: 'DVC Project',
-      match: ['DVC project', 'project', 'projects'],
+      match: [
+        'DVC project',
+        'project',
+        'projects',
+        'DVC repository',
+        'DVC repositories'
+      ],
      desc: `
 Initialized by running \`dvc init\` in the **workspace** (typically in a Git
 repository). It will contain the
 [\`.dvc/\` directory](/doc/user-guide/dvc-files-and-directories) and
 [DVC-files](/doc/user-guide/dvc-file-format) created with commands such as
-\`dvc add\` or \`dvc run\`. It may also be a Git repository.
-      `
-    },
-    {
-      name: 'DVC Repository',
-      match: ['DVC repository', 'DVC repositories'],
-      desc: `
-**DVC project** initialized using \`dvc init\` in a Git repository. It will
-contain \`.git/\` and [\`.dvc/\`](/doc/user-guide/dvc-files-and-directories)
-directories, as well as any DVC-files created by DVC.
+\`dvc add\` or \`dvc run\`. Some DVC commands require it to be in a Git repo –
+explained in each [command reference](/doc/command-reference) but usually
+obvious from the context.
      `
    },


These terms (DVC project and DVC repository) were merged per #931 (review), which was the right move. But after a short discussion in iterative/dvc#3277 (comment) I think maybe we should make "DVC repository" (or just repo) the main or only term?

Initially I only thought of repos as the Git part of DVC projects, but later on the term DVC repo started popping up and we even had its glossary entry, now we've merged them both but left "project" as the main term. Comparing vs the core DVC repo though, the term "project" is not used at all so it would be easier to just manage the single term "repo" even when sometimes it will be necessary to disambiguate between Git vs DVC – a problem we currently have anyway.

Thoughts @shcheklein ? I can do this in my next regular updates or in its own PR (if it affects lots of files) if so.

jorgeorpinel added 2 commits January 18, 2020 20:41

user-guide: add language hints section to docs contrib guide

5bf345b

including use of emojis per #855

cmd ref: link from supported remote types in remote add to remote modify

ec92b7a

per #809

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 19, 2020 03:01 Inactive

jorgeorpinel mentioned this pull request Jan 19, 2020

cmd ref: link from remote add to remote modify #809

Closed

user-guide: add note about bold and italic text to docs contrib guide

dfcd3be

for #686

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 19, 2020 04:43 Inactive

cmd ref: update get/import-url to reflect directory limitations

394e9c8

for #841

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 19, 2020 20:09 Inactive

jorgeorpinel mentioned this pull request Jan 19, 2020

cmd ref: document dir support for import-url and get-url #841

Closed

jorgeorpinel commented Jan 19, 2020

View reviewed changes

public/static/docs/command-reference/import-url.md Show resolved Hide resolved

cmd ref: update get and import output to latest DVC version 0.82.0

a893bc7

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 19, 2020 23:35 Inactive

jorgeorpinel commented Jan 19, 2020

View reviewed changes

public/static/docs/command-reference/get.md Outdated Show resolved Hide resolved

cmd ref: remove unnecessary space around "output" in get

0167276

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 19, 2020 23:52 Inactive

jorgeorpinel added 2 commits January 20, 2020 13:31

cmd ref: review checkout automation example

1f2ba8d

in prep for #506

cmd ref: add note about DVC Git hooks only working on DVC-enabled bra…

02a13f3

…nches per #506 (comment)

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 20, 2020 19:35 Inactive

jorgeorpinel commented Jan 20, 2020

View reviewed changes

public/static/docs/command-reference/checkout.md Outdated Show resolved Hide resolved

jorgeorpinel mentioned this pull request Jan 21, 2020

document that hooks don't act in a non-DVC branch #506

Closed

cmd ref: add note about automatic hooks to all applicable commands:

bafbe5f

install, checkout, commit, repro, and push per #931 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 21, 2020 18:59 Inactive

jorgeorpinel mentioned this pull request Jan 21, 2020

update pulling data from the cloud example #938

Merged

jorgeorpinel added 2 commits January 22, 2020 14:11

Merge branch 'master' into jorgeorpinel and

f4900e8

fix formatting of user-guide/contributing

cache: improve note about .dir files and add in appropriate docs

0324fa2

rel: iterative/dvc/issues/3182

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 22, 2020 20:14 Inactive

cmd ref: add a couple more notes about .dir files

7d1b469

ref: iterative/dvc/issues/3182

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 22, 2020 20:31 Inactive

tutorials: comlpete sharing example terminal commands and

7224a28

review "Nothing to reproduce." output samples (after `dvc repro`) rel: #938

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-vv6ti1 January 24, 2020 20:09 Inactive

jorgeorpinel added 2 commits February 3, 2020 01:09

cmd ref: another revision to import --rev explanation

f409d81

per #931 (comment)

install: remove unnecessary HTML comment from macos

102ac47

per #931 (review)

jorgeorpinel commented Feb 3, 2020

View reviewed changes

public/static/docs/install/macos.md Outdated Show resolved Hide resolved

jorgeorpinel added a commit that referenced this pull request Feb 3, 2020

user-guide: update note about natural language in docs contrib

41f234e

per #931 (comment)

user-guide: update note about natural language in docs contrib

9e3d4fb

per #931 (comment)

jorgeorpinel force-pushed the jorgeorpinel branch from 41f234e to 9e3d4fb Compare February 3, 2020 07:33

iterative deleted a comment from shcheklein Feb 3, 2020

get/import: update with correct behavior info (only DVC/Git repos)

ad5f91e

per iterative/dvc/pull/3277 and precursor to merging DVC repo term into DVC project (glossary)

jorgeorpinel mentioned this pull request Feb 3, 2020

get/import: they don't work with any DVC project, only DVC repos (as well as Git repos) iterative/dvc#3277

Merged

3 tasks

cmd ref: also update cmd args (see previous commit)

88c4546

for iterative/dvc/pull/3277

jorgeorpinel force-pushed the jorgeorpinel branch from 6609de3 to 88c4546 Compare February 3, 2020 19:16

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-uoubdq February 3, 2020 19:31 Inactive

glossary: merge "DVC repo" into "DVC project"

c55a2fe

per #931 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorgeorpine-uoubdq February 3, 2020 20:04 Inactive

jorgeorpinel added a commit that referenced this pull request Feb 3, 2020

cmd ref: consistent spacing in positional arguments (Synopsis) section

8c97bb1

from #931 (review)

jorgeorpinel mentioned this pull request Feb 3, 2020

Regular updates (early Feb) #966

Merged

1 task

shcheklein reviewed Feb 4, 2020

View reviewed changes

shcheklein approved these changes Feb 4, 2020

View reviewed changes

shcheklein merged commit 366d160 into master Feb 4, 2020

jorgeorpinel mentioned this pull request Feb 4, 2020

cmd ref: review correctness of dvc install ref and notes in other docs #968

Closed

jorgeorpinel added a commit that referenced this pull request Feb 4, 2020

cmd ref: typo in get

0e5332c

per #931 (review)

jorgeorpinel added a commit that referenced this pull request Feb 4, 2020

glossary: removed unnecessary sentence in project def.

7ef0968

per #931 (comment)

jorgeorpinel added a commit that referenced this pull request Feb 4, 2020

cmd ref: refactor notes in get-url and import-url

1551b4b

per #931 (review)

jorgeorpinel commented Feb 7, 2020

View reviewed changes

weekly-digest bot mentioned this pull request Feb 9, 2020

Weekly Digest (2 February, 2020 - 9 February, 2020) #984

Closed

This was referenced Feb 10, 2020

term: replace "working tree/dir" for "workspace"? (where appropriate) iterative/dvc#3302

Closed

more GAPI privacy policy updates #987

Merged

jorgeorpinel deleted the jorgeorpinel branch March 21, 2020 03:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

doc: regular updates (late Jan) #931

doc: regular updates (late Jan) #931

Uh oh!

jorgeorpinel commented Jan 19, 2020 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shcheklein Feb 4, 2020

Uh oh!

jorgeorpinel Feb 4, 2020

Uh oh!

jorgeorpinel Feb 4, 2020

Uh oh!

shcheklein Feb 4, 2020

Uh oh!

jorgeorpinel Feb 4, 2020

Uh oh!

shcheklein left a comment

Uh oh!

jorgeorpinel commented Feb 4, 2020

Uh oh!

jorgeorpinel Feb 7, 2020 •

edited

Loading

Uh oh!

Uh oh!

doc: regular updates (late Jan) #931

doc: regular updates (late Jan) #931

Uh oh!

Conversation

jorgeorpinel commented Jan 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shcheklein Feb 4, 2020

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel Feb 4, 2020

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel Feb 4, 2020

Choose a reason for hiding this comment

Uh oh!

shcheklein Feb 4, 2020

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel Feb 4, 2020

Choose a reason for hiding this comment

Uh oh!

shcheklein left a comment

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel commented Feb 4, 2020

Uh oh!

jorgeorpinel Feb 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jorgeorpinel commented Jan 19, 2020 •

edited

Loading

jorgeorpinel Feb 7, 2020 •

edited

Loading