Skip to content

Commit

Permalink
Merge branch 'master' into 2020-04-27
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed May 6, 2020
2 parents ce7a3d7 + 44d2fa5 commit 1796293
Show file tree
Hide file tree
Showing 61 changed files with 1,436 additions and 510 deletions.
6 changes: 3 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@ commands:
# Download cached dependencies.
- restore_cache:
keys:
- v1-dependencies-{{ checksum "yarn.lock" }}
- v2-dependencies-{{ checksum "yarn.lock" }}
# Fallback to using the latest cache if no exact match is found.
- v1-dependencies-
- v2-dependencies-

- run: yarn

# Upload dependencies cache.
- save_cache:
paths:
- node_modules
key: v1-dependencies-{{ checksum "yarn.lock" }}
key: v2-dependencies-{{ checksum "yarn.lock" }}

jobs:
test:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,6 @@ typings/
.cache
public
tmp

# Copied 404 for Heroku
404.html
7 changes: 7 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
tasks:
- init: yarn install && yarn build
command: yarn develop

ports:
- port: 8000
onOpen: open-preview
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

[![Maintainability](https://api.codeclimate.com/v1/badges/5872e0a572ec8b74bd8d/maintainability)](https://codeclimate.com/github/iterative/dvc.org/maintainability)
[![CircleCI](https://circleci.com/gh/iterative/dvc.org.svg?style=svg)](https://circleci.com/gh/iterative/dvc.org)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/iterative/dvc.org)

[DVC](https://github.com/iterative/dvc) project website's source code.
[Documentation](https://dvc.org/doc) and [blog](https://dvc.org/blog) content.
Contributions to are welcome!
Contributions are welcome!

# Contributing Docs

Expand Down
2 changes: 2 additions & 0 deletions config/prismjs/dvc-commands.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ module.exports = [
'pipeline show',
'pipeline list',
'pipeline',
'plot',
'plot diff',
'move',
'metrics show',
'metrics remove',
Expand Down
6 changes: 6 additions & 0 deletions content/authors/jorge_orpinel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: Jorge Orpinel Pérez
avatar: jorge.jpg
---

Technical writer and developer at [http://dvc.org](http://dvc.org)
2 changes: 1 addition & 1 deletion content/blog/2019-03-05-march-19-dvc-heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ $ dvc remote modify upstream endpointurl <url>
```

Find and click the `S3 API compatible storage` on
[this page](https://dvc.org/doc/commands-reference/remote-add)
[this page](https://dvc.org/doc/commands-reference/remote/add)

### Q: [Why DVC creates and updates `.gitignore` file?](https://discordapp.com/channels/485586884165107732/485596304961962003/543914550173368332)

Expand Down
4 changes: 2 additions & 2 deletions content/blog/2019-04-18-april-19-dvc-heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ interesting takeaways.

- It depends on a few Python libraries that it installs as dependencies (they
are specified in the
[`requirements.txt`](https://github.com/iterative/dvc/blob/master/requirements.txt)).
[`setup.py`](https://github.com/iterative/dvc/blob/master/setup.py)).

- It does not depend on Git and theoretically could be run without any SCM.
Running it on top of a Git repository however is recommended and gives you an
Expand Down Expand Up @@ -173,7 +173,7 @@ Use `--global` when you specify the remote settings. Then remote will be visible
for all projects on the same machine. `--global` — saves remote configuration to
the global config (e.g. `~/.config/dvc/config`) instead of a per project one —
`.dvc/config`. See more details
[here](https://dvc.org/doc/commands-reference/remote-add).
[here](https://dvc.org/doc/commands-reference/remote/add).

### Q: [How do I version a large dataset in S3 or any other storage?](https://discordapp.com/channels/485586884165107732/485596304961962003/554679392823934977)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,21 @@ the transcript

DVC is a pretty young project, developed and maintained solely by engineers. As
many OS projects we started from the bottom and for a long time our
[documentation](https://dvc.org/doc) was a bunch of bits and pieces. Nowadays
improving documentation is one of our top priorities. We moved to the new
in-house built documentation engine and started working with several technical
writers. Certain parts have been tremendously improved recently, e.g.
[Get Started](https://dvc.org/doc/get-started) and
[certain parts of Commands Reference](https://dvc.org/doc/commands-reference/fetch)
. So far most of our documentation has been written majorly by the engineering
team and there is need for improving the overall structure and making some parts
more friendly from a new user perspective. We have mostly complete
[reference documentation](https://dvc.org/doc/commands-reference) for each
command, although some functions are missing good actionable examples. We also
have a [User Guide](https://dvc.org/doc/user-guide/dvc-files-and-directories),
however it is not in very good shape. We strive for making our documentation
clear and comprehensive for users of various backgrounds and proficiency levels
and this is where we do need some fresh perspective.
[documentation](/doc) was a bunch of bits and pieces. Nowadays improving
documentation is one of our top priorities. We moved to the new in-house built
documentation engine and started working with several technical writers. Certain
parts have been tremendously improved recently, e.g.
[Get Started](/doc/get-started) and
[certain parts of Commands Reference](/doc/commands-reference/fetch) . So far
most of our documentation has been written majorly by the engineering team and
there is need for improving the overall structure and making some parts more
friendly from a new user perspective. We have mostly complete
[reference documentation](/doc/commands-reference) for each command, although
some functions are missing good actionable examples. We also have a
[User Guide](/doc/user-guide/dvc-files-and-directories), however it is not in
very good shape. We strive for making our documentation clear and comprehensive
for users of various backgrounds and proficiency levels and this is where we do
need some fresh perspective.

### How DVC documentation is built

Expand All @@ -95,7 +95,7 @@ is built with Node.js + React, including the documentation engine (built
in-house).

Each documentation page is a static Markdown file in the repository, e.g.
[example here](https://github.com/iterative/dvc.org/blob/master/static/docs/get-started/example-versioning.md.).
[example here](https://github.com/iterative/dvc.org/blob/master/content/docs/command-reference/index.md).
It is rendered dynamically in the browser, no preprocessing is required. It
means that tech writers or contributors need to write/edit a Markdown file,
create a pull request and merge it into the master branch of the
Expand Down Expand Up @@ -132,18 +132,16 @@ First of all, we want to bring more structure and logic to our documentation to
improve user onboarding experience. The goal is for a new user to have a clear
path they can follow and understand what takeaways each part of the
documentation provides. In particular, improving how
[Get Started](https://dvc.org/doc/get-started),
[Tutorials](https://dvc.org/doc/tutorial) and
[Examples](https://dvc.org/doc/get-started/example-versioning) relate to each
other, restructuring the existing [User Guide](https://dvc.org/doc/user-guide)
to explain basic concepts, and writing more use cases that resonate with ML
engineers and data scientists.
[Get Started](/doc/get-started), [Tutorials](/doc/tutorial) and
[Examples](/doc/tutorials/versioning) relate to each other, restructuring the
existing [User Guide](https://dvc.org/doc/user-guide) to explain basic concepts,
and writing more use cases that resonate with ML engineers and data scientists.

The other issue we would like to tackle is improving and expanding the existing
reference docs — commands descriptions, examples, etc. It involves filling in
the gaps and developing new sections, similar to
[this one](https://dvc.org/doc/commands-reference/fetch). We would also love to
see more illustrative materials.
[this one](/doc/commands-reference/fetch). We would also love to see more
illustrative materials.

### Project 1: Improving and expanding User Guide

Expand All @@ -169,27 +167,26 @@ preferably some basic ML or data science experience.
### Project 3: Improving new user onboarding

**Description and details:** Analyze and restructure user walkthrough across
[Get started](https://dvc.org/doc/get-started),
[Tutorials](https://dvc.org/doc/tutorial) and
[Examples](https://dvc.org/doc/get-started/example-versioning). These three have
one thing in common — hands-on experience with DVC. If you choose this project,
we will work together to come up with a better location for the Examples (to
move them out of the Get Started shadow), and a better location for the
Tutorials (to reference external tutorials that were developed by our community
members and published on different platforms).
[Get started](/doc/get-started), [Tutorials](/doc/tutorial) and
[Examples](/doc/tutorials/versioning). These three have one thing in common —
hands-on experience with DVC. If you choose this project, we will work together
to come up with a better location for the Examples (to move them out of the Get
Started shadow), and a better location for the Tutorials (to reference external
tutorials that were developed by our community members and published on
different platforms).

**Mentors**: [@shcheklein](https://github.com/shcheklein) and
[@dmpetrov](https://github.com/dmpetrov)

### Project 4: Improving commands reference

**Description and details:** We will work on improving our
[Commands reference](https://dvc.org/doc/commands-reference) section. This
includes expanding and filling in the gaps. One of the biggest pain points right
now are Examples. Users want them to be
[Commands reference](/doc/commands-reference) section. This includes expanding
and filling in the gaps. One of the biggest pain points right now are Examples.
Users want them to be
[easy to run and try](https://github.com/iterative/dvc.org/issues/198) and here
is a lot to be done in terms of improvement. We have a good example of how is
should be done [here](https://dvc.org/doc/commands-reference/fetch).
should be done [here](/doc/commands-reference/fetch).

**Mentors**: [@shcheklein](https://github.com/shcheklein) and
[@dmpetrov](https://github.com/dmpetrov)
Expand Down
27 changes: 12 additions & 15 deletions content/blog/2019-05-21-may-19-dvc-heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,10 @@ Every time you run `dvc add` to start tracking some data artifact, its path is
automatically added to the `.gitignore` file, as a result it is hard to commit
it to git by mistake — you would need to explicitly modify the `.gitignore`
first. The feature to track some external data is called
[external outputs](https://dvc.org/doc/user-guide/external-outputs) (if all you
need is to track some data artifacts). Usually it is used when you have some
data on S3 or SSH and don’t want to pull it into your working space, but it’s
working even when your data is located on the same machine outside of the
repository.
[external outputs](/doc/user-guide/managing-external-data) (if all you need is
to track some data artifacts). Usually it is used when you have some data on S3
or SSH and don’t want to pull it into your working space, but it’s working even
when your data is located on the same machine outside of the repository.

### Q: [How do I wrap a step that downloads a file/directory into a DVC stage?](https://discordapp.com/channels/485586884165107732/485596304961962003/571342592508428289) I want to ensure that it runs only if file has no been downloaded yet

Expand Down Expand Up @@ -192,7 +191,7 @@ $ dvc config cache.protected true

The last one is highly recommended to make links in your working space read-only
to avoid corrupting the cache. Read more about different link types
[here](https://dvc.org/doc/user-guide/large-dataset-optimization).
[here](/doc/user-guide/large-dataset-optimization).

To add your data first time to the DVC cache, do a clone of the repository on a
big partition and run `dvc add` to add your data. Then you can do `git pull`,
Expand Down Expand Up @@ -222,8 +221,7 @@ flexibility (e.g. you need to use different credentials for different projects,
etc) check out
[this guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html)
to configure custom aws profiles and then you could use them with DVC using
these
[remote options](https://dvc.org/doc/commands-reference/remote-add#options).
these [remote options](/doc/commands-reference/remote-add#options).

### Q: [How can I output multiple metrics from a single file?](https://discordapp.com/channels/485586884165107732/485596304961962003/566000729505136661)

Expand Down Expand Up @@ -288,13 +286,12 @@ re-running your commands.
### Q: [I have projects that use data that’s stored in S3. I never have data locally to use `dvc push`, but I would like to have this data version controlled.](https://discordapp.com/channels/485586884165107732/485596304961962003/563352000281182218) Is there a way to use the features of DVC in this use case?

Yes! This DVC features is called
[external outputs](https://dvc.org/doc/user-guide/external-outputs) and
[external dependencies](https://dvc.org/doc/user-guide/external-dependencies).
You can use one of them or both to track, process, and version your data on a
cloud storage without downloading it locally.
[external outputs](/doc/user-guide/large-dataset-optimization) and
[external dependencies](/doc/user-guide/external-dependencies). You can use one
of them or both to track, process, and version your data on a cloud storage
without downloading it locally.

<hr />

If you have any questions, concerns or ideas, let us know
[here](https://dvc.org/support) and our stellar team will get back to you in no
time!
If you have any questions, concerns or ideas, let us know [here](/support) and
our stellar team will get back to you in no time!
2 changes: 1 addition & 1 deletion content/blog/2019-08-01-july-19-dvc-heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ interesting takeaways.
### Q: I have within one git repository different folders with very different content (basically different projects, or content I want to have different permissions to), and I thought about using different buckets in AWS as remotes. [I’m not sure if it’s possible with DVC to store some files in some remote, and some other files in some other remote, is it?](https://discordapp.com/channels/485586884165107732/485596304961962003/575718048330416158)

You can definitely add more than one remote (see
[dvc remote add](https://dvc.org/doc/commands-reference/remote-add)) and then
[dvc remote add](https://dvc.org/doc/commands-reference/remote/add)) and then
[dvc push](https://dvc.org/doc/commands-reference/push) has a `-R` option to
pick which one to send the cached data files (deps, outs, etc) to. We would not
recommend doing this though. It complicates the commands you have to run — you
Expand Down
6 changes: 3 additions & 3 deletions content/blog/2019-09-26-september-19-dvc-heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ If you are not in SF on this date and happen to be in Europe — don’t miss th
PyCon DE & PyData Berlin 2019 joint event on October 9–11. We cannot make it to
Berlin this year, but we were thrilled to discover 2 independent talks featuring
DVC by
[Alessia Marcolini](https://de.pycon.org/program/pydata-ppgwxl-version-control-for-data-science-alessia-marcolini/)
[Alessia Marcolini](https://pyvideo.org/pydata-berlin-2019/version-control-for-data-science.html)
and
[Katharina Rasch](https://de.pycon.org/program/pydata-cwmae7-tools-that-help-you-get-your-experiments-under-control-katharina-rasch/).
[Katharina Rasch](https://pyvideo.org/pydata-berlin-2019/tools-that-help-you-get-your-experiments-under-control.html).

Some other highlights of the end of summer:

Expand All @@ -59,7 +59,7 @@ Some other highlights of the end of summer:
[DVC documentation](https://github.com/iterative/dvc.org) (and have something
special in mind to celebrate our 100th contributors).

- we enjoyed working with all the talented
- We enjoyed working with all the talented
[Google Season of docs](https://developers.google.com/season-of-docs/)
applicants and now moving to the next stage with our chosen tech writer
[Dashamir Hoxha](http://dashohoxha.fs.al/).
Expand Down
6 changes: 3 additions & 3 deletions content/blog/2019-11-05-october-19-dvc-heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ it this year. Here are some of the highlights:
over the world: check
[this blogpost in French](https://blog.octo.com/mise-en-application-de-dvc-sur-un-projet-de-machine-learning/)
or
[this tutorial in German](https://jupyter-tutorial.readthedocs.io/de/latest/reproduce/dvc/init.html)!
[this tutorial in German](https://jupyter-tutorial.readthedocs.io/de/latest/productive/dvc/)!

- Having great time working with a [tech writer](https://github.com/dashohoxha)
brought to us by the
- Having a great time working with a
[tech writer](https://github.com/dashohoxha) brought to us by the
[Google Season of Docs](https://developers.google.com/season-of-docs) program.
Check out these
[interactive tutorials](https://dvc.org/doc/tutorials/interactive) we’ve
Expand Down
4 changes: 1 addition & 3 deletions content/blog/2020-02-10-february-20-dvc-heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,4 @@ Here are a few more stories on our radar:
[Elvie](https://www.elvie.com/en-us/), a maker of tech for women's health
(pretty neat mission). The decorations on the job posting are ours 😎

![](/uploads/images/2020-02-10/elvie.png)_A
[job advertisement](https://www.jobstoday.co.uk/job/40530810/data-engineer/?TrackID=8)
featuring DVC._
![](/uploads/images/2020-02-10/elvie.png)_A job advertisement featuring DVC._
4 changes: 2 additions & 2 deletions content/blog/2020-04-06-april-20-dvc-heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ tags:
---

Welcome to the April Heartbeat, our
[monthly roundup of cool happenings](https://dvc-landing-april-heart-6d0onb.herokuapp.com/tags/heartbeat),
good reads and other bright spots in our community.
[monthly roundup of cool happenings](https://dvc.org/tags/heartbeat), good reads
and other bright spots in our community.

## News

Expand Down
Loading

0 comments on commit 1796293

Please sign in to comment.