bulleted points end with : or .

[dnabanita7]

Fixes #491

[dnabanita7]

https://dvc.org/doc/understanding-dvc/collaboration-issues it still has "?" at end of bulleted points. Shall I change or keep it the same. Now, all of the bulleted points end with ":" or "."

[shcheklein]

before we do this, let's first come up with a set or rules

[jorgeorpinel]

Good start, thanks! There's many more bullet lists in the docs though.

Let's see if we can agree to the rules I suggested in #491 (comment) and then keep going here 🙂

[dnabanita7]

The docs containing bulleted points are:

1. changelog
   a) 0.18 : ends with colon or fullstop
   b) 0.35 : ends with colon or fullstop
2. get-started
   a) agenda : ends with nothing
   b) configure : phrases ends with nothing
   c) example:pipelines : ends with colon
3. user guide
   a) dvc files and directories : starts with a small letter, sentences ends with fullstop, and phrases with nothing.
   b) file format : now phrases ends with nothing
   c) contributing : ends with colon and fullstop as per required.
   d) contributing-documentation : ends with fullstop.
   e) shell-autocomplete : now phrases ends with nothing and sentences with fullstop.
   f) usage-analytics : sentences ends with fullstop and phrases with nothing.
   g) dvcignore : ends with fullstop.
4. tutorial
   a) define-ml-pipeline : now ends with nothing.
5. understanding-dvc
   a) collaboration issues : ends with question-mark.
   b) what-is-dvc : ends with fullstop.
   c) comparison-to-existing-technologies : ends with colon and subpoints with fullstop.
   d) resources : ends with colon and bulleted links with nothing.
6. All options of commands-reference : all ends with fullstop

[jorgeorpinel]

Do you see my review now @naba7 ? My bad. I think I didn't submit it before so you couldn't see it.

[jorgeorpinel]

@naba7 another thing missing here is to review all the docs. I see many files that still have bullets ending in ;, for example. Search files for regex ^\-.*\n?.*; like this:

[jorgeorpinel]

Thanks for the updates. Here are some comments on the changes.

Also, there are more bullet lists that need review outside of static/docs/commands-reference/ for example in static/docs/understanding-dvc/resources.md and at least 3 more files. Please search all of static/docs/ For example searching for this basic regex ^\-.* in all files will show you every single first-level bullet.

[jorgeorpinel]

Yes great work, thanks a lot @naba7! I hope I'm not being to demanding but here are a few last things:

• You missed a bullet list in static/docs/user-guide/autocomplete.md (lines 46-8).
• Several bullet lists in static/docs/user-guide/dvc-file-format.md start with lower case but I think they should start with Capital letter (not sure, please double agains check the rules we agreed).
• The last 2 bullets of the list in static/docs/user-guide/dvc-files-and-directories.md shuold not end in period .. Please use text:

  - `.dvc/updater.lock` - lock file for `.dvc/updater`
  
  - `.dvc/lock` - lock file for the whole DVC project

Please also address the comments below:

[dnabanita7]

Thanks @jorgeorpinel Yes, my bad! I have changed those. Please take a look!

[jorgeorpinel]

All done! Thanks again @naba7

@shcheklein I'm approving the changes I requested in my review.

[shcheklein]

thanks @naba7 and @jorgeorpinel !