iterative/dvc.org

📖 DVC website and documentation

DVC project website's source code. Documentation content. Contributions are welcome!

Contributing Docs

Please see our Contributing guide for more details. Thanks to all our contributors!

Getting help

If you have any questions, please join the community and use the #dev-docs channel to discuss any issues in our website or docs. We are very responsive and happy to help.

Copyright

Source code of this project is distributed under the Apache license version 2.0 (see the LICENSE file in the project root).

Except where otherwise noted, documentation, blog content, images are licensed under a CC BY 4.0 license.

By submitting a pull request for this project, you agree to license your contribution under the Apache license 2.0 (source code) or CC BY 4.0 (documentation). Exceptions could be made to content and any other materials that are published on our blog.

dvc.org's Issues

Layout is broken on iPad

Footer info

DataVersionControl INC --> Iterative, Inc

Company: The only link we have is http://iterative.ai/

Get started: let's use the tutorial link for now https://blog.dataversioncontrol.com/data-version-control-tutorial-9146715eda46

docs: add "how to run tests" to "contribute" section

LinkedIn image is missing

Consider leaving a single definition for dvc on the front page

As discussed with @dmpetrov: We should consider leaving a single definition of Open-source Version Control System for Data Science Projects instead of animating all three, since it is the most easy to understand and using only it will also reduce flickering from animation.

Static large hero text header on mobile

Like it was discussed in Slack channel:

мне показалось, что все равно можно чуть больше сделать, но радикально это не решит ничего

поверх текста?
или вместо?

lozhkovoygleb [10:32 AM]
Тогда сложится концепция и будет не пусто

ivan [10:33 AM]
я вот думаю что надо просто убрать эту анимацию и действительно одну статическую надпись центрированную
это то что ты предлагаешь выше?

lozhkovoygleb [10:34 AM]
Я предлагаю большим написать Data Version Control, а ниже пусть крутится анимация

ivan [10:35 AM]
да, кажется что сложно будет
можно по-моему просто без анимации сделать

lozhkovoygleb [10:35 AM]
Можно убрать анимацию на телефонах

ivan [10:35 AM]
можно и так и так попробовать конечно

lozhkovoygleb [10:35 AM]
И оставить первую фразу

ivan [10:35 AM]
да
сделать ее по центру и больше

lozhkovoygleb [10:36 AM]
Которую выбираем?

ivan [10:36 AM]
давай пока Version Control
или радндомно!

lozhkovoygleb [10:36 AM]
Понял, принял

ivan [10:36 AM]
когда заходишь 🙂

lozhkovoygleb [10:36 AM]
Рандомную интересный вариант

how to: "uninstall dvc" for both binary and pip packages

DVC FAQ, Wiki or getting started

From iterative/dvc#776 by @dmpetrov:

Inspired by iterative/dvc#754 and our offline discussion with @shcheklein about simple data versioning scenarios.

Topics:

installation
data file versioning with cloud storage backend (S3, GCP, SFTP)
data file modifications
file versioning in HDFS
ML pipeline basic
DVC for in data engineering pipelines
tracking and navigating by metrics
remotes

Video black border

On certain resolutions there are black top and bottom borders visible around the video:

add HDFS documentation

Moved from iterative/dvc#766

Fonts, buttons, all elements should look like in Zeplin

E.g. Download button, footer fonts, etc. We need to check everything.

Page bad rendering

Details summary tags are not well rendered at the docs page : https://dvc.org/doc/get-started/add-files.

<details><summary><strong>Expand to learn more about internals</strong></summary>
<p>
You can see that actual data file has been moved (usually hardlink or
reflink is created, so no physical copying is happening) to the
<code>.dvc/cache</code>:
</p>
<pre>
    $ ls -R .dvc/cache
        .dvc/cache/a3:
        04afb96060aad90176268345e10355
</pre>
<p>
where <code>a3/04afb96060aad90176268345e10355</code> is an MD5 hash of the
<code>data.xml</code> file, and if you check the <code>data.xml.dvc</code>
meta-file you will see that it has this hash inside.
</p>
</details>

HTH

docs: external dependecies/outputs

Fix Layout iPhone landscape

user-guide: cache/remote/workspace relationships

Describe how these three relate and what they are.

Fonts are not properly embedded

On a Mac system when font (Bandon) is not installed system-wide site is not being dispalyed properly (especially is was obvious on SVG logo and SGV image which I converted to PNG)

Video align + button

Check Zeplin

docs: specify that dvc will automatically create directories on remote

docs: use cases: Share data and model files for multiple users on single machine

Learn more links

Add links to the features pages

Commands in hero

The commands in hero should be changing.

Image scroll in mobile

In mobile, we need 3 images and > and < buttons to scroll. Or 1, 2 and 3 buttons.

Footer remove extra space

Rotate text like on improvado.io

Check the discussion around hero's text on Invision - comments 6 and 10.

Download links

1. Please use links from the releases page: https://github.com/iterative/dvc/releases

2. "Linux" should be separated to "Linux Deb" and "Linux RPM"

3. Not clickable item "pip install dvc" is needed.

An opinion from a random guy about dvc.org

1. "Git for Machine Learning" with strikethrough looks like a bug. I want to close the page.

My comment: It makes sense. Why don't we say:
"Open-source Version Control System for Data Science Projects.
(or Git for Machine Learning)
"

2. DVC logo (top left) was not rendered.
   https://dvc.org/static/img/logo.png

My comment: I tried to refresh (Ctrl+r) the web page - it didn't help.

3. In general - the website looks very professional.

Conf.py is not in the code directory of the sample code

It is a talk of executing the following command in this part of tutorial.

$ wget https://dvc.org/s3/so/code.tgz

By executing this command, conf.py is not included in the downloaded code directory.

So, if you try to execute the commands in this part of the tutorial, an error will be displayed.

I got conf.py temporarily by referring to this page, but since it is tutorial, I thought that it would be better to fix and I set up this issue.

Remove horizontal scrolling

It's especially visible in Firefox, for example. Looks like the site is too wide for Macbook 13''. It should be adapting itself dynamically to some extent.

Design elements should be the same as in Zeplin

IE fix layout, download button, etc

A lot of stuff is broken in IE still

user-guide: write about managing metrics

A small article on how to use dvc metrics to manage metrics for your project in the most convenient way.

docs: use cases: Share data and model files

Fix layout on tables

On iPad layout is broken.

Get started link and behavior

Get started should point to the same place everywhere (tutorial for now).

Get started (buttons down the site) behave strangely - they scroll site to the very up first and only after some delay they redirect.

Github links to dvc repo

All the GitHub link on dvc.org website should point to https://github.com/iterative/dvc (not just iterative)

Out of sync hero commands animation on a mobile

If you turn off browser app and/or phone for a while it breaks animation workflow. Sometimes I saw all them started fading in/out simultaneously.

git-annex faq appears to be incorrect

I'm not sure the comparison to git annex is correct. For example "Git-annex loses all metadata when shared by Git server" isn't true, as it is possible to move files around via special remotes, and store the metadata on git-only servers (datalad, which wraps git annex, shows an example of doing this exact thing).

Add github stars indicator

add "How to store data on your own server" tutorial/guide

Probably needs a better name.

guide: describe the how hash values (`md5`) are calculated

Tell about how we compute checksums for files, why we dos2unix when computing md5 and how to map the md5 value found in dvcfile to an actual cache file at .dvc/cache

"Learn more" font fix color

Learn more links should always have the same color as was designed

Favicon IE transparency

Scale video properly

On a smaller screens video should keep round corners, button, and scale image.

Fix CSS animation performance

Animation via CSS loads CPU 20-30% on macbook pro. Should be fixed or moved to gif. Are there any other options?

Improvement: move video before use cases in mobile version

Otherwise when I click watch video in hero it's confusing to see text instead.

No twitter logo in the footer

No twitter logo on Linux/Chrome:

Though works great on Mac/Chrome.

Front page commands

As we've discussed with @dmpetrov , commands on the front page should be modified to be more correct:

dvc add images.z | -> dvc add images.zip
dvc run python cnn.py -> dvc run -d images.zip -o model.p python cnn.py
dvc remote add s3://mybucket -> dvc remote add myrepo s3://mybucket

Doc: metrics

Moved from iterative/dvc#765

dmpetrov commented on Jun 13
Metrics are not in doc and not in the tutorial

Add blog and support links (menus, footer)

Add link to the blog (menus, footer) (BLOG) - https://blog.dataversioncontrol.com/

Add link to the discourse (SUPPORT) - https://discuss.dataversioncontrol.com/

HDFS is coming soon

"HDFS, Hive & Apache Spark" is not ready yet. We need to mention this - "Coming soon".