From 0b073543611db4abd24c75d3b55abad6850b2111 Mon Sep 17 00:00:00 2001 From: dberenbaum Date: Tue, 19 Jul 2022 17:27:38 -0400 Subject: [PATCH] readme: drop table of contents readme: top-level links in comments --- README.rst | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 83502cca3..3623fea73 100644 --- a/README.rst +++ b/README.rst @@ -2,12 +2,14 @@ `Website `_ • `Docs `_ -• `VS Code Extension `_ • `Blog `_ -• `Twitter `_ -• `Chat (Community & Support) `_ • `Tutorial `_ -• `Mailing List `_ +• `How DVC works`_ +• `VS Code Extension`_ +• `Installation`_ +• `Related Technologies`_ +• `Contributing`_ +• `Community and Support`_ |CI| |Maintainability| |Coverage| |VS Code| |DOI| @@ -15,7 +17,7 @@ | -**Data Version Control** or **DVC** is a command line tool and `VS Code Extension `_ to help you develop reproducible machine learning projects: +**Data Version Control** or **DVC** is a command line tool and `VS Code Extension`_ to help you develop reproducible machine learning projects: #. **Version** your data and models. Store them in your cloud storage but keep their version info in your Git repo. @@ -29,9 +31,6 @@ #. **Share** experiments and automatically reproduce anyone's experiment. -.. contents:: **Contents** - :backlinks: none - Quick start =========== @@ -84,12 +83,14 @@ They specify all steps required to produce a model: input dependencies including Last but not least, `DVC Experiment Versioning `_ lets you prepare and run a large number of experiments. Their results can be filtered and compared based on hyperparameters and metrics, and visualized with multiple plots. +.. _`VS Code Extension`: + Visual Studio Code Extension ============================ |VS Code| -To get use DVC as a GUI right from your VS Code IDE, install the `DVC Extension `_ from the Marketplace. +To use DVC as a GUI right from your VS Code IDE, install the `DVC Extension `_ from the Marketplace. It currently features experiment tracking and data management, and more features (data pipeline support, etc.) are coming soon! |VS Code Extension Overview| @@ -189,6 +190,8 @@ Fedora / CentOS (rpm) sudo yum update sudo yum install dvc +.. _`Related Technologies`: + Comparison to related technologies ================================== @@ -229,13 +232,14 @@ Thanks to all our contributors! |Contribs| -Mailing List -============ +Community and Support +===================== -Want to stay up to date? -Want to help improve DVC by participating in our occasional polls? -Subscribe to our `mailing list `_. -No spam, really low traffic. +* `Twitter `_ +* `Forum `_ +* `Discord Chat `_ +* `Email `_ +* `Mailing List `_ Copyright =========