Skip to content

Commit

Permalink
blog: add Aman's talk to GSoD 2020 post
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed May 5, 2020
1 parent 780d99a commit 3122881
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 38 deletions.
84 changes: 46 additions & 38 deletions content/blog/2020-04-30-gsod-ideas-2020.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,31 +25,37 @@ 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
write open source software documentation with mentorship from our team, read on.

In last year's season, we matched with a prolific
[writer](https://github.com/dashohoxha) who helped us restructure important part
of our docs, and address key issues.
**TLDR**: Skip to [project ideas](#project-ideas).

> https://twitter.com/DVCorg/status/1205203662827483136
[DVC](https://dvc.org/) has a dedicated docs team and a
[well-defined process](/doc/user-guide/contributing/docs) for creating and
maintaining our documentation, modeled in part based on our past GSoD
experience. We are happy to share our experience, introduce technical writers to
the world of open source and machine learning best practices, and work together
on improving our documentation.

Some of the achievements of this partnership were:
## Previous experience

- Reorganized our [tutorials](https://github.com/iterative/dvc.org/pull/666) and
core [contribution guide](https://github.com/iterative/dvc.org/pull/726);
- Created [interactive lessons](https://github.com/iterative/dvc.org/issues/546)
on [Katacoda](https://www.katacoda.com/dvc):
In last year's Season, we matched with prolific writer
[Dashamir](https://github.com/dashohoxha), who helped us give proper structure
important part of our docs, and address key issues.

![](/uploads/images/2020-04-30/Katacoda_scenario.png) _Data Tracking scenario,
step 2, in the "Get Started with DVC" course_
https://twitter.com/DVCorg/status/1205203662827483136

- Docs [cleanup](https://github.com/iterative/dvc.org/pull/734);
Some of our achievements together were:

- Reorganized our [tutorials](https://github.com/iterative/dvc.org/pull/666) and
core [contribution guide](https://github.com/iterative/dvc.org/pull/726)
- Created [interactive lessons](https://github.com/iterative/dvc.org/issues/546)
on [Katacoda](https://www.katacoda.com/dvc)
- Docs [cleanup](https://github.com/iterative/dvc.org/pull/734)
- Suggested the creation of a
[How To](https://github.com/iterative/dvc.org/issues/563) section for our
docs;
[How To](https://github.com/iterative/dvc.org/issues/563) section for our docs
- Other
[contributions](https://github.com/iterative/dvc.org/pulls?q=is%3Apr+is%3Aclosed+author%3Adashohoxha)

Another collaborator we connected with via #GSoD2019 was an amazing
[intern](https://github.com/algomaster99), who helped us address
Another collaborator we connected with via GSoD’19 was an amazing student
intern, [Aman](https://github.com/algomaster99). He helped us address
[dozens of tickets](https://github.com/iterative/dvc.org/pulls?q=is%3Apr+author%3Aalgomaster99+is%3Aclosed)
related to our Node.js docs web app. For example:

Expand All @@ -58,21 +64,26 @@ related to our Node.js docs web app. For example:
[user guide](https://github.com/iterative/dvc.org/pull/366), and created a
much needed
[documentation contribution](https://github.com/iterative/dvc.org/pull/317)
guide;
guide

- [Formatted](https://github.com/iterative/dvc.org/pull/328) the source code of
our docs and established an
[automated mechanism](https://github.com/iterative/dvc.org/pull/386) to
enforce pretty formatting going forward;
enforce pretty formatting going forward

- Implemented floating tooltips based on a special
[glossary](https://github.com/iterative/dvc.org/pull/431):
- Implemented super useful hovering tooltips based on a special
[glossary](https://github.com/iterative/dvc.org/pull/431)

![](/uploads/images/2020-04-30/tooltip.png)
![](/uploads/images/2020-04-30/tooltip.png) _From the `dvc remote` command
reference_

DVC now has a dedicated docs team and a
[well-defined process](/doc/user-guide/contributing/docs) for creating and
maintaining our documentation, modeled in part based on this past experience.
Another positive result of the program was that our open source collaborators
organized talks and meetups with our mentorship:

![](/uploads/images/2020-04-30/SciPy_India_Aman.png) _Our intern Aman took a
several-hour long train ride to
[talk](https://static.fossee.in/scipy2019/SciPyTalks/SciPyIndia2019%5FS011%5FStoring%5Fa%5Ffew%5Fversions%5Fof%5Fa%5F5GB%5Ffile%5Fin%5Fa%5Fdata%5Fscience%5Fproject%5F20191130.mp4)
at [SciPy India 2019](https://scipy.in/2019)._

## Prerequisites to apply

Expand Down Expand Up @@ -127,14 +138,12 @@ technical writer, [Jorge](https://github.com/jorgeorpinel).
- 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);
[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`;
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.
automatically saves experiment checkpoints between commits

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

Expand Down Expand Up @@ -180,17 +189,16 @@ technical writer, [Jorge](https://github.com/jorgeorpinel).
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);
[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).

> See other
> [doc-engine](https://github.com/iterative/dvc.org/issues?q=is%3Aopen+is%3Aissue+label%3Adoc-engine)
> and
> [blog-engine](https://github.com/iterative/dvc.org/issues?q=is%3Aopen+is%3Aissue+label%3Ablog-engine)
> issues.
[positioning](https://github.com/iterative/dvc.org/issues/1198)
- Other
[doc-engine](https://github.com/iterative/dvc.org/issues?q=is%3Aopen+is%3Aissue+label%3Adoc-engine)
and
[blog-engine](https://github.com/iterative/dvc.org/issues?q=is%3Aopen+is%3Aissue+label%3Ablog-engine)
issues

_Difficulty rating:_ Advanced<br/><br/>

Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3122881

Please sign in to comment.