diff --git a/content/blog/2020-04-30-gsod-ideas-2020.md b/content/blog/2020-04-30-gsod-ideas-2020.md index e037725f3a..60f22d7662 100644 --- a/content/blog/2020-04-30-gsod-ideas-2020.md +++ b/content/blog/2020-04-30-gsod-ideas-2020.md @@ -4,10 +4,11 @@ date: 2020-04-30 description: | A call for writer applications for Google Season of Docs 2020. 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) + DVC is looking for technical writers to take part in + [Google Season of Docs 2020](https://developers.google.com/season-of-docs) — + a unique program sponsored by Google that pairs technical writers with open + source projects. In this post we introduce our goals for the program, and + specific [project ideas](#project-ideas) for potential candidates. picture: 2019-04-23/post-image.png pictureComment: author: jorge_orpinel @@ -18,29 +19,56 @@ tags: - Mentoring --- -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 +After a successful experience with the first edition of **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 write open source software documentation with mentorship from our team, read on. -In last year's season, we partner with a [writer](https://github.com/dashohoxha) -who helped us restructure important part of our docs, and address key issues. -For example: +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. + +> https://twitter.com/DVCorg/status/1205203662827483136 + +Some of the achievements of this partnership were: -- [Reorganize](https://github.com/iterative/dvc.org/pull/666) our tutorials -- Build [interactive lessons](https://github.com/iterative/dvc.org/issues/546). - Check out our Tweet about it: +- 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): - https://twitter.com/DVCorg/status/1205203662827483136 + ![](/uploads/images/2020-04-30/Katacoda_scenario.png) _Data Tracking scenario, + step 2, in the "Get Started with DVC" course_ -- Docs [cleanup](https://github.com/iterative/dvc.org/pull/734) -- Suggest creating a [How To](https://github.com/iterative/dvc.org/issues/563) - section of our docs +- 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; - Other - [contributions](https://github.com/iterative/dvc.org/issues?q=is%3Aissue+dashohoxha+label%3Adoc-content) + [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 +[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: + +- Contributed to our + [command reference](https://github.com/iterative/dvc.org/pull/315) and + [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; +- [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; +- Implemented floating tooltips based on a special + [glossary](https://github.com/iterative/dvc.org/pull/431): + + ![](/uploads/images/2020-04-30/tooltip.png) DVC now has a dedicated docs team and a [well-defined process](/doc/user-guide/contributing/docs) for creating and @@ -71,19 +99,21 @@ be in touch anyway. We'd love to hear from you. ## Project ideas Below are several project ideas that are an immediate priority for the DVC docs -team. We welcome writers to create their own proposals, even if they differ from -our ideas. Projects will be primarily mentored by our lead technical writer, -[Jorge](https://github.com/jorgeorpinel). +team. We welcome technical writers to create their own proposals, even if they +differ from our ideas. Most projects will be mentored primarily by our lead +technical writer, [Jorge](https://github.com/jorgeorpinel). -1. **How-to section.** Other than our +1. **"How To" section.** Other than our [use cases](https://dvc.org/doc/use-cases), we still lack a good place to - answer common questions in our docs (think FAQ). We have compiled + answer common questions in our docs (think FAQ). We have compiled [set of topics](https://github.com/iterative/dvc.org/issues/899) that we - think would be best explained in a new "How to" section for this purpose. + think would be best explained in a new **How To** section for this purpose. + This project would imply relocating bits and pieces of info from existing docs into new how-tos, as well as writing significant new material to - complete them. And possibly also expanding on our - [troubleshooting](https://dvc.org/doc/user-guide/troubleshooting) page. + complete them. Expanding on our + [troubleshooting](https://dvc.org/doc/user-guide/troubleshooting) page would + probably go well as part of this project as well. _Difficulty rating:_ Beginner-Medium

@@ -111,11 +141,15 @@ our ideas. Projects will be primarily mentored by our lead technical writer, 1. **Video tutorials.** Written documentation is great, but other media can also be important for our organization to reach a wide variety of learners. Expanding to video is also a core part of our developer advocacy strategy. - One of DVC's priorities for the season is creating a library of video + + One of DVC's priorities for this year is creating a library of video tutorials ranging from short explanations of basic DVC functions to more advanced use cases. You could assist in writing the scripts or even take the lead producing some videos, so image/video editing skills would come in handy - (optional). + (optional). For inspiration, here's a fun intro to DVC video we produced some + time ago: + + https://www.youtube.com/watch?v=4h6I9_xeYA4 **Mentor**: [Elle](https://github.com/andronovhopf) diff --git a/static/uploads/images/2020-04-30/Katacoda_scenario.png b/static/uploads/images/2020-04-30/Katacoda_scenario.png new file mode 100644 index 0000000000..c2ff4edd0f Binary files /dev/null and b/static/uploads/images/2020-04-30/Katacoda_scenario.png differ diff --git a/static/uploads/images/2020-04-30/tooltip.png b/static/uploads/images/2020-04-30/tooltip.png new file mode 100644 index 0000000000..ed057a1b18 Binary files /dev/null and b/static/uploads/images/2020-04-30/tooltip.png differ