This page contains the details of a technical writing project accepted for Google Season of Docs.
Project summary
- Open source organization:
- DVC
- Technical writer:
- imhardikj
- Project name:
- Implementing "How To" section guides and updating DVC 1.0 docs
- Project length:
- Standard length (3 months)
Project description
One of the aims of this project is to implement the “How To” section that addresses in detail the common questions related to DVC. The next aim is to update documentation as per the latest DVC 1.x release. There are significant changes compared to the previous releases and hence the docs are required to be updated to the latest version. After this is complete, the next tasks will be based on the priorities of DVC during the writing period.
Project goals:
1) Some examples for the proposed “How to” section: - How to ""undo"" 'dvc add' (How to undo mistakes). - How to add a missing dependency to an existing pipeline. - How to use DVC when the data is stored in an external drive (External data management guide).
These are some of the ideas based on the Github issue (github.com/iterative/dvc.org/issues/899) which can be included in this section. This also involves relocating some of the existing documentation (for example, “Running DVC on Windows”) into this section. If a how-to goal is not suitable for this section, then it can be updated in the command reference (or relevant documentation) with an example. This section can be expanded to include more how-to issues whenever I come across them on community channels.
2) The other significant part of this project is to update the documentation now that DVC 1.0 is released (dvc.org/blog/dvc-1-0-release), and as per other relevant updates that may be released by September. Docs (all command references, etc.) are supposed to be updated according to these changes, some of which are mentioned in this epic issue (github.com/iterative/dvc.org/issues/1255).
3) I can also work on updating Tutorials and Katacoda scenarios (github.com/iterative/dvc.org/issues/670).
4) If the How-to section, updating DVC 1.0 docs and the Katacoda scenarios are finished before the end of the writing period, then rest of the work will be based upon the DVC priorities during that time and other miscellaneous tasks.
Time commitment:
I will have my regular college during the writing period. I don’t have any other commitments except this. I will be able to commit 30 hours per week in the entire duration of the project.