DVC project
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["\u003cp\u003eThis project aims to create a "How To" section in the DVC documentation addressing common user questions with practical examples.\u003c/p\u003e\n"],["\u003cp\u003eThe project involves updating the DVC documentation to reflect the changes introduced in the DVC 1.0 release.\u003c/p\u003e\n"],["\u003cp\u003eTutorials and Katacoda scenarios will be updated to align with the latest DVC version and functionalities.\u003c/p\u003e\n"],["\u003cp\u003eIf primary goals are completed early, the project will address other DVC priorities and miscellaneous documentation tasks.\u003c/p\u003e\n"]]],["The project focuses on enhancing DVC's documentation. Key actions include creating a \"How To\" section addressing common questions, such as undoing 'dvc add', adding pipeline dependencies, and managing external data. Another goal is updating all documentation to reflect DVC 1.x, including command references and relevant changes. Additional tasks involve improving Tutorials and Katacoda scenarios. The writer is committed to working on the project for 30 hours per week. Future work will prioritize ongoing needs.\n"],null,["# DVC project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\n### Project summary\n\nOpen source organization:\n: DVC\n\nTechnical writer:\n: imhardikj\n\nProject name:\n: Implementing \"How To\" section guides and updating DVC 1.0 docs\n\nProject length:\n: Standard length (3 months)\n\n### Project description\n\nOne 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.\n\n#### Project goals:\n\n1) Some examples for the proposed \"How to\" section:\n- How to \"\"undo\"\" 'dvc add' (How to undo mistakes).\n- How to add a missing dependency to an existing pipeline.\n- How to use DVC when the data is stored in an external drive (External data management guide).\n\nThese 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.\n\n2) 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).\n\n3) I can also work on updating Tutorials and Katacoda scenarios (github.com/iterative/dvc.org/issues/670).\n\n4) 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.\n\n#### Time commitment:\n\nI 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."]]
