Add Basic Concepts + Introduction files #296
Conversation
|
@shcheklein Done as per me, please let me know if you think I can make it more useful. |
|
|
||
| ## Remote | ||
|
|
||
| In DVC you can have remote data storage or a remote git hosted code server. |
There was a problem hiding this comment.
remote git hosted code server - I'm not sure I understand this. Where does it come from and what does it mean?
There was a problem hiding this comment.
Git can be hosted on any remote ip, if you put code + git on the remote ip, you could call the ip as remote git hosted code server (https://git-scm.com/book/en/v1/Git-on-the-Server, https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server).
| ## Remote | ||
|
|
||
| In DVC you can have remote data storage or a remote git hosted code server. | ||
| A remote can be specified by the remote type prefix and a path. You can find |
There was a problem hiding this comment.
remote type prefix - remote is usually specified by its URL
There was a problem hiding this comment.
I think in dvc adding a remote should be specified by type + prefix? Remotes can be
locals3gsazuresshhdfshttp
You would run dvc remote add -d /typer/remote path/url.
There was a problem hiding this comment.
It's still not 80 symbols. Please, check the README.md#Contributing.
A few questions here and there to address.
In general, the doc is a good starting point, but I'm not sure we can consider the ticker resolved. Right now it's not very informative. It does not explain how cache is related to working space, etc.
|
I used vim and have I added introduction.md as well, please let me know if you think any more additions would close the ticket. ref #296 (comment). |
|
I think writing just on few things and just on relations when you have the docs per type clearly written, you would have less text when describing in |
tapaswenipathak
changed the title
@tapaswenipathak I'm not sure I understand your question. |
|
On Mon, May 13, 2019 at 2:36 AM Ivan Shcheklein ***@***.***> wrote:
I used vim and have set colorcolumn=80. Can you let me know the line number w/ more than 80 chars. You would find lines w/ less than 80 chars as I think documentation shouldn't have character breakings.
@tapaswenipathak I'm not sure I understand your question.
Great if you can let me know the line more than 80 characters. I meant
word separation.
…
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
--
Tapasweni
|
|
@tapaswenipathak on the screenshot you shared you can see a lot of lines that are mode than 80 symbols. Here is an example - https://github.com/iterative/dvc.org/pull/296/files#diff-2e4a72ea9621637441b257e4b8428e16R18 |
|
On Mon, May 13, 2019 at 11:14 PM Ivan Shcheklein ***@***.***> wrote:
@tapaswenipathak on the screenshot you shared you can see a lot of lines that are mode than 80 symbols. Here is an example - https://github.com/iterative/dvc.org/pull/296/files#diff-2e4a72ea9621637441b257e4b8428e16R18
In documentation
https://github.com/iterative/dvc.org/blob/b909caf7039aa9f13be50a4645cef5674d476626/static/docs/user-guide/basic-concepts.md#cache
this would be under 80. Should I move this in next line?
…
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
--
Tapasweni
|
|
@tapaswenipathak sorry for the delay. Either I'm missing something or I don't get you questions sorry. There is a style guide for the documentation. Every .md file should wrap all lines (except a few very specific case, like long URLs) at 80 symbols. Please, read also this link: https://dvc.org/doc/user-guide/contributing-documentation#code-style-guidelines |
|
@tapaswenipathak sorry, may be it's unclear a little bit, but style guide dictates the way raw files should be formatted. |
|
The .md file has
The formatted file has Guidelines has As per this guidelines the formatting is correct? Do you mean?
The formatted file will have much lesser than 80. Please let me know if I should move the word in next line. |
|
On Fri, May 17, 2019 at 10:24 AM Ivan Shcheklein ***@***.***> wrote:
@tapaswenipathak sorry, may be it's unclear a little bit, but style guide dictates the way raw files should be formatted.
You quickly posted, the formatting was improper. Added
a comment. Please let me know.
…
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
--
Tapasweni
|
|
@tapaswenipathak you got the idea right! You need to wrap the lines in your raw files at 80 symbols. If you use vim I would recommend to install the pre-commit hook that will check and format the files for you. |
|
On Fri, 17 May 2019, 10:46 Ivan Shcheklein ***@***.*** wrote:
@tapaswenipathak <https://github.com/tapaswenipathak> you got the idea
right! You need to wrap the lines in your raw files at 80 symbols. If you
use vim I would recommend to install the pre-commit hook that will check
and format the files for you.
Ah ok, I have been writing without pre commit hook till now. Have used pre commit hook
against my work. Will do. Should I fix the guidelines as well? This line suggests formatting
should be correct and it is. Please let me know.
… —
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#296?email_source=notifications&email_token=AA7TVISMWYCCTM2F4NRYDUDPVY5UFA5CNFSM4HK4WS72YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODVTYFNQ#issuecomment-493322934>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AA7TVIRHHRHS3QV5RJ4UJZ3PVY5UFANCNFSM4HK4WS7Q>
.
|
Yes, let's clarify it. Thanks! |
|
@shcheklein do you have any more comments? Gentle reminder for #293, #292 a quick review. |
There was a problem hiding this comment.
- Does not fit code style. There are still lines that are > 80 symbols.
- Content is not informative and does not give that much value on top of what we already have.
My recommendation: focus on one task at a time, go through DVC tutorials and get started, write one single new section that gives some values and does not just repeat other sections.
|
oh @shcheklein should I close this pr then? |
|
@tapaswenipathak I'm not sure, to be honest. It mostly depends on what are you going to do next with all three PRs. |
|
I don't think I understand the inputs, I added the suggestions/iterations on this pr per the suggestions. If you can write what is missing in this pr or if you think I should close this, please let me know. Other two def I can close as no work is present on them or any iterations, after creating the pr. |
|
@tapaswenipathak let's close all three then. Sorry, I just don't have capacity right now to collaborate with you on this on the level it requires to get this stuff done :( |
|
ok. :( |
Fix #53.
Hi folks,
I am a GSoD applicant, have read your ideas list and working on closing tickets present in the list.
I have participated in multiple SoC/WoC and have been involved w/ open source since years. I have worked with Jupyter and have worked w/ ML algorithms. I am fully familiar with these areas. DVC.org is great fit for me but as a product new for me.
On docs I like detailed docs having every step present so that the user can be spoon feeded, makes it easily usable.
I see a scope of writing introduction on a lot of commands in the doc but curious if you are interested as most of the commands have a writeup written separately. I found diagrams as well on these. Please let me know what you think would be best for your org. Thanks!