Skip to content

Commit

Permalink
blog: add meat to DVC 1.0 docs idea in GSoD 2020 post
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed May 4, 2020
1 parent 9f0aaa6 commit 39479d7
Showing 1 changed file with 32 additions and 20 deletions.
52 changes: 32 additions & 20 deletions content/blog/2020-04-30-gsod-ideas-2020.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ description: |
descriptionLong: |
DVC is looking for writers to take part in
[Google Season of Docs 2020](https://developers.google.com/season-of-docs).
Returning candidates: Skip to [project ideas](#project-ideas)
picture: 2019-04-23/post-image.png
pictureComment:
author: jorge_orpinel
Expand All @@ -16,17 +18,17 @@ tags:
- Mentoring
---

Exciting announcement! After a successful experience with
[Google Season of Docs](https://developers.google.com/season-of-docs) 2019,
we're putting out a call for writers to apply to work with DVC as part of the
After a successful experience with **Google Season of Docs**
[in 2019](/blog/dvc-project-ideas-for-google-summer-of-docs-2019), we're putting
out a call for writers to apply to work with DVC as part of the
[2020 edition](https://developers.google.com/season-of-docs). If you want to get
involved with open source software documentation with mentorship from our team,
read on.

DVC has a well organized docs team and a
[well-defined process](https://dvc.org/doc/user-guide/contributing/docs) for
creating and maintaining our documentation, while working closely with the core
engineering team.
DVC has a dedicated docs team and a
[well-defined process](/doc/user-guide/contributing/docs) for creating and
maintaining our documentation, while working closely with the core engineering
team.

## Prerequisites to apply

Expand All @@ -36,12 +38,12 @@ few skills we look for in applicants.
1. **Clear English writing.** We strive express the concepts, processes, and
details around DVC clearly, correctly, and completely. We use general and
friendly wording as much as possible and pay close attention to consistency
in our terminology.
in our terminology. Our team will help with copy editing.

1. **Command line experience.** [DVC](/doc/home) is a command line tool that
builds on top of [Git](https://git-scm.com/), so being able to play with it
and test the features will be very useful. Creating and managing files,
GNU/Linux commands, file and permission admin are desired skills.
GNU/Linux commands, file and permission administration are desired skills.

1. **People skills.** We put a high value on communication: the ability to
discuss ideas, explain your goals, report progress, and work kindly with more
Expand All @@ -60,11 +62,21 @@ our ideas. Projects will be primarily mentored by our lead technical writer,
1. **DVC 1.0 docs.** We are soon to release DVC 1.0.0! This version brings some
significant changes that for the first time in our
[release history](https://github.com/iterative/dvc/releases) are not
completely backward-compatible. The main change is a multi-stage _pipelines
file_ that substitutes
[DVC-files](https://dvc.org/doc/user-guide/dvc-file-format). We expect the
process to fully update all our previous docs will take a few months, and you
could help us with this!
completely backward-compatible. We expect that fully updating all our
previous docs will take a few months, and you could help us with this! The
main new features are:

- A
[multi-stage _pipelines file_](https://github.com/iterative/dvc/issues/1871)
that partially substitutes
[DVC-files](https://dvc.org/doc/user-guide/dvc-file-format);
- Separation between
[scalar vs. continuous metrics](https://github.com/iterative/dvc/issues/3409),
and new commands to visualize them, such as `dvc plot`;
- A new [run cache](https://github.com/iterative/dvc/issues/1234) that
automatically saves experiment checkpoints between commits;
- Major [performance](https://github.com/iterative/dvc/issues/3488)
improvements.

_Difficulty rating:_ Beginner-Medium<br/><br/>

Expand All @@ -79,7 +91,7 @@ our ideas. Projects will be primarily mentored by our lead technical writer,

**Mentor**: [Elle](https://github.com/andronovhopf)

_Difficulty rating:_ Medium<br/><br/>
_Difficulty rating:_ Beginner-Medium<br/><br/>

1. **Interactive guides.** Many of our docs include command line examples to
illustrate how DVC works. In some cases these are full guides we want people
Expand All @@ -103,12 +115,12 @@ our ideas. Projects will be primarily mentored by our lead technical writer,
developed over the years to host our landing pages, docs, and blog all in a
high-performance, advanced static site (Node.js, Gatsby, React, Typescript).
We have several goals to further improve the usability and structure of our
site, such as
site, such as:

- creating a
[special docs home page](https://github.com/iterative/dvc.org/issues/1073).
- improving [mobile menus](https://github.com/iterative/dvc.org/issues/808).
- better navigation sidebar
- Creating a
[special docs home page](https://github.com/iterative/dvc.org/issues/1073);
- Improving [mobile menus](https://github.com/iterative/dvc.org/issues/808);
- Better navigation sidebar
[highlighting](https://github.com/iterative/dvc.org/issues/753) and
[positioning](https://github.com/iterative/dvc.org/issues/1198).

Expand Down

0 comments on commit 39479d7

Please sign in to comment.