From 8269124983dbb904142250eeb22ff92d1fcd7b03 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 15 Mar 2020 13:56:27 -0600 Subject: [PATCH 01/14] docs: create landing section for docs, put index above get-started --- public/static/docs/get-started/index.md | 11 ------ public/static/docs/index.md | 10 ++++++ public/static/docs/install/index.md | 11 ++++++ public/static/docs/sidebar.json | 47 ++++++++++++++----------- 4 files changed, 47 insertions(+), 32 deletions(-) create mode 100644 public/static/docs/index.md diff --git a/public/static/docs/get-started/index.md b/public/static/docs/get-started/index.md index 55f2a7898e..6ae3871a68 100644 --- a/public/static/docs/get-started/index.md +++ b/public/static/docs/get-started/index.md @@ -7,17 +7,6 @@ You'll need [Git](https://git-scm.com) to run the commands in this guide. Also, if DVC is not installed, please follow these [instructions](/doc/install) to do so. -Before you start ... - -✅ Please, join our [community](/chat) or see these [support](/support) channels -if you have any questions or need any help. We are very responsive ⚡. - -✅ Check out our [GitHub repository](https://github.com/iterative/dvc) and give -us a ⭐ if you like the project! - -✅ Contribute to DVC [on GitHub](https://github.com/iterative/dvc) or help us -improve this [documentation](https://github.com/iterative/dvc.org) 🙏. - When you're done, feel free to check out official and community [tutorials](/doc/tutorials). They provide in-depth explanations, [interactive](/doc/tutorials/interactive) scenarios, and various examples on how diff --git a/public/static/docs/index.md b/public/static/docs/index.md new file mode 100644 index 0000000000..f23f432291 --- /dev/null +++ b/public/static/docs/index.md @@ -0,0 +1,10 @@ +Before you start ... + +✅ Please, join our [community](/community) or see these [support](/support) +channels if you have any questions or need any help. We are very responsive ⚡. + +✅ Check out our [GitHub repository](https://github.com/iterative/dvc) and give +us a ⭐ if you like the project! + +✅ Contribute to DVC [on GitHub](https://github.com/iterative/dvc) or help us +improve this [documentation](https://github.com/iterative/dvc.org) 🙏. diff --git a/public/static/docs/install/index.md b/public/static/docs/install/index.md index c375c0ca61..c0aa30bbcd 100644 --- a/public/static/docs/install/index.md +++ b/public/static/docs/install/index.md @@ -1,3 +1,14 @@ +Before you start ... + +✅ Please, join our [community](/community) or see these [support](/support) +channels if you have any questions or need any help. We are very responsive ⚡. + +✅ Check out our [GitHub repository](https://github.com/iterative/dvc) and give +us a ⭐ if you like the project! + +✅ Contribute to DVC [on GitHub](https://github.com/iterative/dvc) or help us +improve this [documentation](https://github.com/iterative/dvc.org) 🙏. + # Installation Please double check that you don't already have DVC (for example running diff --git a/public/static/docs/sidebar.json b/public/static/docs/sidebar.json index 05c59ac6fc..d44c6e7764 100644 --- a/public/static/docs/sidebar.json +++ b/public/static/docs/sidebar.json @@ -1,4 +1,30 @@ [ + { + "slug": "docs", + "source": "index.md", + "label": "Docs" + }, + { + "slug": "install", + "source": "install/index.md", + "children": [ + { + "label": "Mac OS", + "slug": "macos" + }, + "windows", + "linux", + { + "label": "Pre-release Version", + "slug": "pre-release" + }, + { + "label": "Shell Completion", + "slug": "completion" + }, + "plugins" + ] + }, { "slug": "get-started", "source": "get-started/index.md", @@ -29,27 +55,6 @@ } ] }, - { - "slug": "install", - "source": "install/index.md", - "children": [ - { - "label": "Mac OS", - "slug": "macos" - }, - "windows", - "linux", - { - "label": "Pre-release Version", - "slug": "pre-release" - }, - { - "label": "Shell Completion", - "slug": "completion" - }, - "plugins" - ] - }, { "slug": "tutorials", "source": "tutorials/index.md", From c35f27dad64825e3e5d325fe1ecad31903e5fbe9 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 15 Mar 2020 17:05:37 -0600 Subject: [PATCH 02/14] engine: hardcode landing page for /doc (/static/docs/index.md) ) --- public/static/docs/install/index.md | 11 ----------- public/static/docs/sidebar.json | 5 ----- src/components/Documentation/SidebarMenu/index.js | 2 +- src/utils/sidebar.js | 9 ++++++++- 4 files changed, 9 insertions(+), 18 deletions(-) diff --git a/public/static/docs/install/index.md b/public/static/docs/install/index.md index c0aa30bbcd..c375c0ca61 100644 --- a/public/static/docs/install/index.md +++ b/public/static/docs/install/index.md @@ -1,14 +1,3 @@ -Before you start ... - -✅ Please, join our [community](/community) or see these [support](/support) -channels if you have any questions or need any help. We are very responsive ⚡. - -✅ Check out our [GitHub repository](https://github.com/iterative/dvc) and give -us a ⭐ if you like the project! - -✅ Contribute to DVC [on GitHub](https://github.com/iterative/dvc) or help us -improve this [documentation](https://github.com/iterative/dvc.org) 🙏. - # Installation Please double check that you don't already have DVC (for example running diff --git a/public/static/docs/sidebar.json b/public/static/docs/sidebar.json index d44c6e7764..5f25f7a2e7 100644 --- a/public/static/docs/sidebar.json +++ b/public/static/docs/sidebar.json @@ -1,9 +1,4 @@ [ - { - "slug": "docs", - "source": "index.md", - "label": "Docs" - }, { "slug": "install", "source": "install/index.md", diff --git a/src/components/Documentation/SidebarMenu/index.js b/src/components/Documentation/SidebarMenu/index.js index 7253437034..11b30a3e3c 100644 --- a/src/components/Documentation/SidebarMenu/index.js +++ b/src/components/Documentation/SidebarMenu/index.js @@ -77,7 +77,7 @@ export default function SidebarMenu({ id, sidebar, currentPath, onClick }) { const timeout = setTimeout(() => { psRef.current.update() - scrollIntoView(node, parent, { onlyScrollIfNeeded: true }) + if (node) scrollIntoView(node, parent, { onlyScrollIfNeeded: true }) setIsScrollHidden(false) }, 400) diff --git a/src/utils/sidebar.js b/src/utils/sidebar.js index 8336e0c356..8d9ca7c1fb 100644 --- a/src/utils/sidebar.js +++ b/src/utils/sidebar.js @@ -149,8 +149,15 @@ const normalizedSidebar = normalizeSidebar({ function getItemByPath(path) { const normalizedPath = path.replace(/\/$/, '') const isRoot = normalizedPath === PATH_ROOT.slice(0, -1) + // console.log('fCWS(nS0)', findChildWithSource(normalizedSidebar[0])) const item = isRoot - ? normalizedSidebar[0] + ? { + label: '', + next: '/doc/install', + path: '/doc', + prev: undefined, + source: '/static/docs/index.md' + } : findItem(normalizedSidebar, normalizedPath) if (!item) return false From b289da45365613a84d265f66af08494b38925993 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 15 Mar 2020 17:16:49 -0600 Subject: [PATCH 03/14] engine: fix sidebar test per previous commit --- src/utils/sidebar.js | 5 ++--- src/utils/sidebar.test.js | 9 ++++----- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/src/utils/sidebar.js b/src/utils/sidebar.js index 8d9ca7c1fb..a4e2faf901 100644 --- a/src/utils/sidebar.js +++ b/src/utils/sidebar.js @@ -149,14 +149,13 @@ const normalizedSidebar = normalizeSidebar({ function getItemByPath(path) { const normalizedPath = path.replace(/\/$/, '') const isRoot = normalizedPath === PATH_ROOT.slice(0, -1) - // console.log('fCWS(nS0)', findChildWithSource(normalizedSidebar[0])) const item = isRoot ? { label: '', - next: '/doc/install', path: '/doc', + source: '/static/docs/index.md', prev: undefined, - source: '/static/docs/index.md' + next: '/doc/install' } : findItem(normalizedSidebar, normalizedPath) diff --git a/src/utils/sidebar.test.js b/src/utils/sidebar.test.js index 0147999d4a..0e0c16d60d 100644 --- a/src/utils/sidebar.test.js +++ b/src/utils/sidebar.test.js @@ -322,12 +322,11 @@ describe('SidebarMenu/helper', () => { it('Returns first child for the /doc path', () => { const rawData = ['item-name'] const result = { - label: 'Item Name', - path: '/doc/item-name', - source: '/static/docs/item-name.md', - tutorials: {}, + label: '', + path: '/doc', + source: '/static/docs/index.md', prev: undefined, - next: undefined + next: '/doc/install' } jest.doMock('../../public/static/docs/sidebar.json', () => rawData) From e969e63220ec6f900710531d5d6fc7673767b56a Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 15 Mar 2020 18:59:23 -0600 Subject: [PATCH 04/14] docs: improve doc landing page content --- public/static/docs/index.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/public/static/docs/index.md b/public/static/docs/index.md index f23f432291..c51fd923bd 100644 --- a/public/static/docs/index.md +++ b/public/static/docs/index.md @@ -1,10 +1,22 @@ -Before you start ... +# DVC Documentation -✅ Please, join our [community](/community) or see these [support](/support) -channels if you have any questions or need any help. We are very responsive ⚡. +Welcome! In here you may find all the guiding material and technical documents +needed to learn about DVC: how to use it, how it works, and where to go for +additional resources. + +## Before you start + +✅ Please join our [community](/community) or use the [support](/support) +channels if you have any questions or need specific help. We are very responsive +⚡. ✅ Check out our [GitHub repository](https://github.com/iterative/dvc) and give us a ⭐ if you like the project! ✅ Contribute to DVC [on GitHub](https://github.com/iterative/dvc) or help us improve this [documentation](https://github.com/iterative/dvc.org) 🙏. + +--- + +Please choose a topic from the sidebar to the left, or click the `Next` button +below to start from the beginning ↘ From d07fb8a84dff339dbaf9b625cab592e2ab08cb16 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 15 Mar 2020 19:50:19 -0600 Subject: [PATCH 05/14] doc: roll back special landing page, use new Home sidebar section, and improve its contents --- public/static/docs/sidebar.json | 4 ++++ src/components/Documentation/SidebarMenu/index.js | 2 +- src/utils/sidebar.js | 8 +------- src/utils/sidebar.test.js | 9 +++++---- 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/public/static/docs/sidebar.json b/public/static/docs/sidebar.json index 5f25f7a2e7..20c3cc941d 100644 --- a/public/static/docs/sidebar.json +++ b/public/static/docs/sidebar.json @@ -1,4 +1,8 @@ [ + { + "slug": "Home", + "source": "index.md" + }, { "slug": "install", "source": "install/index.md", diff --git a/src/components/Documentation/SidebarMenu/index.js b/src/components/Documentation/SidebarMenu/index.js index 11b30a3e3c..7253437034 100644 --- a/src/components/Documentation/SidebarMenu/index.js +++ b/src/components/Documentation/SidebarMenu/index.js @@ -77,7 +77,7 @@ export default function SidebarMenu({ id, sidebar, currentPath, onClick }) { const timeout = setTimeout(() => { psRef.current.update() - if (node) scrollIntoView(node, parent, { onlyScrollIfNeeded: true }) + scrollIntoView(node, parent, { onlyScrollIfNeeded: true }) setIsScrollHidden(false) }, 400) diff --git a/src/utils/sidebar.js b/src/utils/sidebar.js index a4e2faf901..8336e0c356 100644 --- a/src/utils/sidebar.js +++ b/src/utils/sidebar.js @@ -150,13 +150,7 @@ function getItemByPath(path) { const normalizedPath = path.replace(/\/$/, '') const isRoot = normalizedPath === PATH_ROOT.slice(0, -1) const item = isRoot - ? { - label: '', - path: '/doc', - source: '/static/docs/index.md', - prev: undefined, - next: '/doc/install' - } + ? normalizedSidebar[0] : findItem(normalizedSidebar, normalizedPath) if (!item) return false diff --git a/src/utils/sidebar.test.js b/src/utils/sidebar.test.js index 0e0c16d60d..0147999d4a 100644 --- a/src/utils/sidebar.test.js +++ b/src/utils/sidebar.test.js @@ -322,11 +322,12 @@ describe('SidebarMenu/helper', () => { it('Returns first child for the /doc path', () => { const rawData = ['item-name'] const result = { - label: '', - path: '/doc', - source: '/static/docs/index.md', + label: 'Item Name', + path: '/doc/item-name', + source: '/static/docs/item-name.md', + tutorials: {}, prev: undefined, - next: '/doc/install' + next: undefined } jest.doMock('../../public/static/docs/sidebar.json', () => rawData) From b1f6a2bceae723f494694b185e43f87664f7879e Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 15 Mar 2020 21:21:16 -0600 Subject: [PATCH 06/14] docs: merge get-started and tutorials into /learn per #1035 --- public/static/docs/changelog/0.18.md | 7 +- public/static/docs/changelog/0.35.md | 5 +- public/static/docs/command-reference/add.md | 4 +- .../static/docs/command-reference/checkout.md | 2 +- .../static/docs/command-reference/commit.md | 2 +- public/static/docs/command-reference/diff.md | 6 +- public/static/docs/command-reference/fetch.md | 15 ++--- public/static/docs/command-reference/get.md | 4 +- .../docs/command-reference/import-url.md | 16 ++--- .../static/docs/command-reference/import.md | 4 +- .../static/docs/command-reference/install.md | 2 +- .../docs/command-reference/metrics/diff.md | 2 +- .../docs/command-reference/metrics/show.md | 6 +- .../docs/command-reference/pipeline/index.md | 2 +- public/static/docs/command-reference/repro.md | 2 +- public/static/docs/command-reference/run.md | 2 +- public/static/docs/get-started/index.md | 13 ---- .../docs/{tutorials => learn}/community.md | 0 .../deep/define-ml-pipeline.md | 0 .../docs/{tutorials => learn}/deep/index.md | 0 .../{tutorials => learn}/deep/preparation.md | 0 .../deep/reproducibility.md | 0 .../{tutorials => learn}/deep/sharing-data.md | 4 +- .../docs/{ => learn}/get-started/add-files.md | 0 .../docs/{ => learn}/get-started/agenda.md | 11 ++-- .../get-started/compare-experiments.md | 2 +- .../docs/{ => learn}/get-started/configure.md | 0 .../get-started/connect-code-and-data.md | 12 ++-- .../{ => learn}/get-started/experiments.md | 0 .../{ => learn}/get-started/import-data.md | 14 ++-- .../{ => learn}/get-started/initialize.md | 0 .../docs/{ => learn}/get-started/metrics.md | 0 .../{ => learn}/get-started/older-versions.md | 4 +- .../docs/{ => learn}/get-started/pipeline.md | 4 +- .../docs/{ => learn}/get-started/reproduce.md | 0 .../{ => learn}/get-started/retrieve-data.md | 7 +- .../{ => learn}/get-started/store-data.md | 11 ++-- .../docs/{ => learn}/get-started/visualize.md | 0 public/static/docs/learn/index.md | 15 +++++ .../docs/{tutorials => learn}/interactive.md | 0 .../docs/{tutorials => learn}/pipelines.md | 11 ++-- .../docs/{tutorials => learn}/versioning.md | 10 +-- public/static/docs/sidebar.json | 64 +++++++++---------- public/static/docs/tutorials/index.md | 10 --- public/static/docs/use-cases/index.md | 2 +- .../versioning-data-and-model-files.md | 6 +- .../user-guide/large-dataset-optimization.md | 10 +-- redirects-list.json | 2 + src/components/Community/data.json | 6 +- src/components/Footer/index.js | 2 +- src/components/HamburgerMenu/index.js | 2 +- src/components/LandingHero/index.js | 2 +- src/components/Nav/index.js | 2 +- src/components/PromoSection/index.js | 2 +- src/components/TrySection/index.js | 2 +- src/utils/redirects.test.js | 6 +- src/utils/sidebar.js | 6 +- 57 files changed, 162 insertions(+), 161 deletions(-) delete mode 100644 public/static/docs/get-started/index.md rename public/static/docs/{tutorials => learn}/community.md (100%) rename public/static/docs/{tutorials => learn}/deep/define-ml-pipeline.md (100%) rename public/static/docs/{tutorials => learn}/deep/index.md (100%) rename public/static/docs/{tutorials => learn}/deep/preparation.md (100%) rename public/static/docs/{tutorials => learn}/deep/reproducibility.md (100%) rename public/static/docs/{tutorials => learn}/deep/sharing-data.md (95%) rename public/static/docs/{ => learn}/get-started/add-files.md (100%) rename public/static/docs/{ => learn}/get-started/agenda.md (75%) rename public/static/docs/{ => learn}/get-started/compare-experiments.md (94%) rename public/static/docs/{ => learn}/get-started/configure.md (100%) rename public/static/docs/{ => learn}/get-started/connect-code-and-data.md (92%) rename public/static/docs/{ => learn}/get-started/experiments.md (100%) rename public/static/docs/{ => learn}/get-started/import-data.md (83%) rename public/static/docs/{ => learn}/get-started/initialize.md (100%) rename public/static/docs/{ => learn}/get-started/metrics.md (100%) rename public/static/docs/{ => learn}/get-started/older-versions.md (91%) rename public/static/docs/{ => learn}/get-started/pipeline.md (92%) rename public/static/docs/{ => learn}/get-started/reproduce.md (100%) rename public/static/docs/{ => learn}/get-started/retrieve-data.md (77%) rename public/static/docs/{ => learn}/get-started/store-data.md (73%) rename public/static/docs/{ => learn}/get-started/visualize.md (100%) create mode 100644 public/static/docs/learn/index.md rename public/static/docs/{tutorials => learn}/interactive.md (100%) rename public/static/docs/{tutorials => learn}/pipelines.md (97%) rename public/static/docs/{tutorials => learn}/versioning.md (97%) delete mode 100644 public/static/docs/tutorials/index.md diff --git a/public/static/docs/changelog/0.18.md b/public/static/docs/changelog/0.18.md index 27890748e4..242bf5e3ca 100644 --- a/public/static/docs/changelog/0.18.md +++ b/public/static/docs/changelog/0.18.md @@ -21,9 +21,10 @@ really excited to share the progress with you: - Commands startup latency reduced 3x -- 📙 **Documentation got better** - a whole new [Get Started](/doc/get-started) - section, new [Use Cases](/doc/use-cases), [User Guide](/doc/user-guide), and - lot of other great stuff you can find here. +- 📙 **Documentation got better** - a whole ne + [Get Started](/doc/learn/get-started) section, new + [Use Cases](/doc/use-cases), [User Guide](/doc/user-guide), and lot of other + great stuff you can find here. - 🙂 **Usability improvements** - DVC interface got more informative and easier to use: diff --git a/public/static/docs/changelog/0.35.md b/public/static/docs/changelog/0.35.md index 774fd547d6..25ac5be81d 100644 --- a/public/static/docs/changelog/0.35.md +++ b/public/static/docs/changelog/0.35.md @@ -13,8 +13,9 @@ improvements) we have done in the last few months: all DVC commands that also have `-a` or `--all-branches` (use all Git branches). -- 📖 The [Get Started](/doc/get-started/agenda) section has been simplified - (e.g. to use tags instead of branches) and extended. We have also prepared a +- 📖 The [Get Started](/doc/learn/get-started/agenda) section has been + simplified (e.g. to use tags instead of branches) and extended. We have also + prepared a [DVC project on GitHub](https://github.com/iterative/example-get-started) that reflects the sequence of chapters in the “get started” section. You can now download the whole project and reproduce all the models. diff --git a/public/static/docs/command-reference/add.md b/public/static/docs/command-reference/add.md index 45ab8ba64b..75e2ebea61 100644 --- a/public/static/docs/command-reference/add.md +++ b/public/static/docs/command-reference/add.md @@ -226,8 +226,8 @@ $ dvc run -f train.dvc \ python train.py ``` -> To follow the full example, see -> [Tutorial: Versioning](/doc/tutorials/versioning). +> To follow the full example, see the [Versioning](/doc/learn/versioning) +> tutorial. If instead we use the `--recursive` (`-R`) option, the output looks like this: diff --git a/public/static/docs/command-reference/checkout.md b/public/static/docs/command-reference/checkout.md index 1b1d02e9cc..1515c9f71a 100644 --- a/public/static/docs/command-reference/checkout.md +++ b/public/static/docs/command-reference/checkout.md @@ -102,7 +102,7 @@ be pulled from remote storage using `dvc pull`. Let's employ a simple workspace with some data, code, ML models, pipeline stages, such as the DVC project created in our -[Get Started](/doc/get-started) section. Then we can see what happens with +[Get Started](/learn/get-started) section. Then we can see what happens with `git checkout` and `dvc checkout` as we switch from tag to tag.
diff --git a/public/static/docs/command-reference/commit.md b/public/static/docs/command-reference/commit.md index 4ba72d7d71..ba0e3ab731 100644 --- a/public/static/docs/command-reference/commit.md +++ b/public/static/docs/command-reference/commit.md @@ -96,7 +96,7 @@ reproducibility in those cases. Let's employ a simple workspace with some data, code, ML models, pipeline stages, such as the DVC project created in our -[Get Started](/doc/get-started) section. Then we can see what happens with +[Get Started](/learn/get-started) section. Then we can see what happens with `git commit` and `dvc commit` in different situations.
diff --git a/public/static/docs/command-reference/diff.md b/public/static/docs/command-reference/diff.md index d064751442..6e574c4970 100644 --- a/public/static/docs/command-reference/diff.md +++ b/public/static/docs/command-reference/diff.md @@ -58,7 +58,7 @@ for example when `dvc init` was used with the `--no-scm` option. ## Examples -For these examples we can use the [Get Started](/doc/get-started) project. +For these examples we can use the [Get Started](/learn/get-started) project.
@@ -103,8 +103,8 @@ $ dvc diff Let's checkout the [3-add-file](https://github.com/iterative/example-get-started/releases/tag/3-add-file) -tag, corresponding to the [Add Files](/doc/get-started/add-files) _Get Started_ -chapter, right after we added `data.xml` file with DVC: +tag, corresponding to the [Add Files](/learn/get-started/add-files) _Get +Started_ chapter, right after we added `data.xml` file with DVC: ```dvc $ git checkout 3-add-file diff --git a/public/static/docs/command-reference/fetch.md b/public/static/docs/command-reference/fetch.md index 4e34086792..cb529a576f 100644 --- a/public/static/docs/command-reference/fetch.md +++ b/public/static/docs/command-reference/fetch.md @@ -46,13 +46,13 @@ since files tracked by DVC should already exist in remote storage, but won't be in the project's cache. (Refer to `dvc remote` for more information on DVC remotes.) These necessary data or model files are listed as dependencies or outputs in a DVC-file (target [stage](/doc/command-reference/run)) so they -are required to [reproduce](/doc/get-started/reproduce) the corresponding +are required to [reproduce](/learn/get-started/reproduce) the corresponding [pipeline](/doc/command-reference/pipeline). (See [DVC-File Format](/doc/user-guide/dvc-file-format) for more information on dependencies and outputs.) `dvc fetch` ensures that the files needed for a DVC-file to be -[reproduced](/doc/get-started/reproduce) exist in cache. If no `targets` are +[reproduced](/learn/get-started/reproduce) exist in cache. If no `targets` are specified, the set of data files to fetch is determined by analyzing all DVC-files in the current branch, unless `--all-branches` or `--all-tags` is specified. @@ -63,7 +63,7 @@ option is used. `dvc fetch`, `dvc pull`, and `dvc push` are related in that these 3 commands perform data synchronization among local and remote storage. The specific way in which the set of files to push/fetch/pull is determined begins with calculating -file hashes when these are [added](/doc/get-started/add-files) with DVC. File +file hashes when these are [added](/learn/get-started/add-files) with DVC. File hashes are stored in the corresponding DVC-files (typically versioned with Git). Only the hashes specified in DVC-files currently in the workspace are considered by `dvc fetch` (unless the `-a` or `-T` options are used). @@ -93,8 +93,8 @@ by `dvc fetch` (unless the `-a` or `-T` options are used). - `-a`, `--all-branches` - fetch cache for all Git branches instead of just the current workspace. This means DVC may download files needed to reproduce different versions of a DVC-file - ([experiments](/doc/get-started/experiments)), not just the ones currently in - the workspace. + ([experiments](/learn/get-started/experiments)), not just the ones currently + in the workspace. - `-T`, `--all-tags` - fetch cache for all Git tags. Similar to `-a` above. Note that both options can be combined, for example using the `-aT` flag. @@ -110,7 +110,7 @@ by `dvc fetch` (unless the `-a` or `-T` options are used). Let's employ a simple workspace with some data, code, ML models, pipeline stages, such as the DVC project created in our -[Get Started](/doc/get-started) section. Then we can see what happens with +[Get Started](/learn/get-started) section. Then we can see what happens with `dvc fetch` as we switch from tag to tag.
@@ -126,8 +126,7 @@ $ cd example-get-started
-The workspace looks almost like in this -[pipeline setup](/doc/tutorials/pipelines): +The workspace looks almost like in this [pipeline setup](/doc/learn/pipelines): ```dvc . diff --git a/public/static/docs/command-reference/get.md b/public/static/docs/command-reference/get.md index 755a5a2ee1..6561a7ce1f 100644 --- a/public/static/docs/command-reference/get.md +++ b/public/static/docs/command-reference/get.md @@ -148,7 +148,7 @@ https://remote.dvc.org/get-started/66/2eb7f64216d9c2c1088d0a5e2c6951 location to place the artifact within the workspace. Combining these two options allows us to do something we can't achieve with the regular `git checkout` + `dvc checkout` process – see for example the -[Get Older Data Version](/doc/get-started/older-versions) chapter of our _Get +[Get Older Data Version](/learn/get-started/older-versions) chapter of our _Get Started_. Let's use the @@ -161,7 +161,7 @@ $ git clone https://github.com/iterative/example-get-started $ cd example-get-started ``` -If you are familiar with our [Get Started](/doc/get-started) project (used in +If you are familiar with our [Get Started](/learn/get-started) project (used in these examples), you may remember that the chapter where we train a first version of the model corresponds to the the `baseline-experiment` tag in the repo. Similarly `bigrams-experiment` points to an improved model (trained using diff --git a/public/static/docs/command-reference/import-url.md b/public/static/docs/command-reference/import-url.md index 64af042a5e..c531fddcf8 100644 --- a/public/static/docs/command-reference/import-url.md +++ b/public/static/docs/command-reference/import-url.md @@ -123,7 +123,7 @@ up to date from the external data source. ## Examples To illustrate these examples we will be using the project explained -in the [Get Started](/doc/get-started) section. +in the [Get Started](/doc/learn/get-started) section.
@@ -132,8 +132,8 @@ in the [Get Started](/doc/get-started) section. Start by cloning our example repo if you don't already have it. Then move into the repo and checkout the [2-remote](https://github.com/iterative/example-get-started/releases/tag/2-remote) -tag, corresponding to the [Configure](/doc/get-started/configure) _Get Started_ -chapter: +tag, corresponding to the [Configure](/doc/learn/get-started/configure) _Get +Started_ chapter: ```dvc $ git clone https://github.com/iterative/example-get-started @@ -143,14 +143,14 @@ $ mkdir data ``` You should now have a blank workspace, just before the -[Add Files](/doc/get-started/add-files) chapter. +[Add Files](/doc/learn/get-started/add-files) chapter.
## Example: Tracking a remote file -An advanced alternate to [Add Files](/doc/get-started/add-files) chapter of the -_Get Started_ section is to use `dvc import-url`: +An advanced alternate to [Add Files](/doc/learn/get-started/add-files) chapter +of the _Get Started_ section is to use `dvc import-url`: ```dvc $ dvc import-url https://data.dvc.org/get-started/data.xml \ @@ -196,7 +196,7 @@ regenerating a data artifact based on the updated data source. [Pipeline](/doc/command-reference/pipeline) reproduction can be triggered based on a changed external dependency. -Let's use the [Get Started](/doc/get-started) project again, simulating an +Let's use the [Get Started](/doc/learn/get-started) project again, simulating an updated external data source. (Remember to prepare the workspace, as explained in [Examples](#examples)) @@ -243,7 +243,7 @@ And instead of an `etag` we have an `md5` hash value. We did this so its easy to edit the data file. Let's now manually reproduce a -[processing chapter](/doc/get-started/connect-code-and-data) from the _Get +[processing chapter](/doc/learn/get-started/connect-code-and-data) from the _Get Started_ project. Download the example source code archive and unzip it: ```dvc diff --git a/public/static/docs/command-reference/import.md b/public/static/docs/command-reference/import.md index bc886ebec4..497fd55beb 100644 --- a/public/static/docs/command-reference/import.md +++ b/public/static/docs/command-reference/import.md @@ -64,7 +64,7 @@ and data `path` fields, and the `outs` section contains the corresponding local workspace `path` field. This is enough data about the imported data, to enable DVC efficiently determining whether the local copy is out of date. -To actually [track the data](https://dvc.org/doc/get-started/add-files), +To actually [track the data](https://dvc.org/doc/learn/get-started/add-files), `git add` (and `git commit`) the import stage. Note that import stages are considered always locked, meaning that if you run @@ -187,7 +187,7 @@ $ dvc get https://github.com/iterative/dataset-registry \ tutorial/ver/data.zip ``` -> Used in our [versioning tutorial](/doc/tutorials/versioning) +> Used in our [versioning tutorial](/doc/learn/versioning) Or diff --git a/public/static/docs/command-reference/install.md b/public/static/docs/command-reference/install.md index 7d716dfd40..99ed0ad61b 100644 --- a/public/static/docs/command-reference/install.md +++ b/public/static/docs/command-reference/install.md @@ -88,7 +88,7 @@ To disable them, you need to **remove** or **edit** those files (i.e. Let's employ a simple workspace with some data, code, ML models, pipeline stages, such as the DVC project created in our -[Get Started](/doc/get-started) section. Then we can see what happens with +[Get Started](/doc/learn/get-started) section. Then we can see what happens with `dvc install` in different situations.
diff --git a/public/static/docs/command-reference/metrics/diff.md b/public/static/docs/command-reference/metrics/diff.md index f1495d06d2..d189e48949 100644 --- a/public/static/docs/command-reference/metrics/diff.md +++ b/public/static/docs/command-reference/metrics/diff.md @@ -70,7 +70,7 @@ They're calculated between two commits (hash, branch, tag, or any Let's employ a simple workspace with some data, code, ML models, pipeline stages, such as the DVC project created in our -[Get Started](/doc/get-started) section. Then we can see what happens with +[Get Started](/doc/learn/get-started) section. Then we can see what happens with `dvc install` in different situations.
diff --git a/public/static/docs/command-reference/metrics/show.md b/public/static/docs/command-reference/metrics/show.md index 210df40304..0d45cafae8 100644 --- a/public/static/docs/command-reference/metrics/show.md +++ b/public/static/docs/command-reference/metrics/show.md @@ -105,6 +105,6 @@ Examples in [add](/doc/command-reference/metrics/add), [remove](/doc/command-reference/metrics/remove) cover most of the basic cases for the `dvc metrics show`. -The [Compare Experiments](/doc/get-started/compare-experiments) chapter of our -_Get Started_ section covers the `-a` option to collect and print a metric file -value across all Git branches. +The [Compare Experiments](/doc/learn/get-started/compare-experiments) chapter of +our _Get Started_ section covers the `-a` option to collect and print a metric +file value across all Git branches. diff --git a/public/static/docs/command-reference/pipeline/index.md b/public/static/docs/command-reference/pipeline/index.md index e4127a1446..cddcfb14da 100644 --- a/public/static/docs/command-reference/pipeline/index.md +++ b/public/static/docs/command-reference/pipeline/index.md @@ -1,6 +1,6 @@ # pipeline -A set of commands to manage [pipelines](/doc/get-started/pipeline): +A set of commands to manage [pipelines](/doc/learn/get-started/pipeline): [show](/doc/command-reference/pipeline/show) and [list](/doc/command-reference/pipeline/list). diff --git a/public/static/docs/command-reference/repro.md b/public/static/docs/command-reference/repro.md index b3318944a9..d6f2e01775 100644 --- a/public/static/docs/command-reference/repro.md +++ b/public/static/docs/command-reference/repro.md @@ -157,7 +157,7 @@ and only execute the final stage. For simplicity, let's build a pipeline defined below. (If you want get your hands-on something more real, see this shot -[pipeline tutorial](/doc/tutorials/pipelines)). It takes this `text.txt` file: +[pipeline tutorial](/doc/learn/pipelines)). It takes this `text.txt` file: ``` dvc diff --git a/public/static/docs/command-reference/run.md b/public/static/docs/command-reference/run.md index c97553f36f..01d0483db8 100644 --- a/public/static/docs/command-reference/run.md +++ b/public/static/docs/command-reference/run.md @@ -54,7 +54,7 @@ Note that `dvc repro` provides an interface to check state and reproduce this graph (pipeline) later. This concept is similar to the one of the [Make](https://www.gnu.org/software/make/) in software build automation, but DVC captures data and caches relevant data artifacts along -the way. See [this tutorial](/doc/tutorials/pipelines) to learn more and try +the way. See [this tutorial](/doc/learn/pipelines) to learn more and try creating a pipeline. ### Avoiding unexpected behavior diff --git a/public/static/docs/get-started/index.md b/public/static/docs/get-started/index.md deleted file mode 100644 index 6ae3871a68..0000000000 --- a/public/static/docs/get-started/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# Get Started - -_Get Started_ is a step-by-step introduction into basic DVC features. It doesn't -go into details much, but provides links and expandable sections to learn more. - -You'll need [Git](https://git-scm.com) to run the commands in this guide. Also, -if DVC is not installed, please follow these [instructions](/doc/install) to do -so. - -When you're done, feel free to check out official and community -[tutorials](/doc/tutorials). They provide in-depth explanations, -[interactive](/doc/tutorials/interactive) scenarios, and various examples on how -DVC can be used. diff --git a/public/static/docs/tutorials/community.md b/public/static/docs/learn/community.md similarity index 100% rename from public/static/docs/tutorials/community.md rename to public/static/docs/learn/community.md diff --git a/public/static/docs/tutorials/deep/define-ml-pipeline.md b/public/static/docs/learn/deep/define-ml-pipeline.md similarity index 100% rename from public/static/docs/tutorials/deep/define-ml-pipeline.md rename to public/static/docs/learn/deep/define-ml-pipeline.md diff --git a/public/static/docs/tutorials/deep/index.md b/public/static/docs/learn/deep/index.md similarity index 100% rename from public/static/docs/tutorials/deep/index.md rename to public/static/docs/learn/deep/index.md diff --git a/public/static/docs/tutorials/deep/preparation.md b/public/static/docs/learn/deep/preparation.md similarity index 100% rename from public/static/docs/tutorials/deep/preparation.md rename to public/static/docs/learn/deep/preparation.md diff --git a/public/static/docs/tutorials/deep/reproducibility.md b/public/static/docs/learn/deep/reproducibility.md similarity index 100% rename from public/static/docs/tutorials/deep/reproducibility.md rename to public/static/docs/learn/deep/reproducibility.md diff --git a/public/static/docs/tutorials/deep/sharing-data.md b/public/static/docs/learn/deep/sharing-data.md similarity index 95% rename from public/static/docs/tutorials/deep/sharing-data.md rename to public/static/docs/learn/deep/sharing-data.md index f03177ce69..c9c1730319 100644 --- a/public/static/docs/tutorials/deep/sharing-data.md +++ b/public/static/docs/learn/deep/sharing-data.md @@ -22,8 +22,8 @@ can be done using the CLI as shown below. > have write access to it, so in order to follow the tutorial you will need to > either create your own S3 bucket or use other types of > [remote storage](/doc/command-reference/remote). E.g. you can set up a local -> remote as we did in the [Configure](/doc/get-started/configure) chapter of -> _Get Started_. +> remote as we did in the [Configure](/doc/learn/get-started/configure) chapter +> of _Get Started_. ```dvc $ dvc remote add -d upstream s3://dvc-public/remote/tutorial/nlp diff --git a/public/static/docs/get-started/add-files.md b/public/static/docs/learn/get-started/add-files.md similarity index 100% rename from public/static/docs/get-started/add-files.md rename to public/static/docs/learn/get-started/add-files.md diff --git a/public/static/docs/get-started/agenda.md b/public/static/docs/learn/get-started/agenda.md similarity index 75% rename from public/static/docs/get-started/agenda.md rename to public/static/docs/learn/get-started/agenda.md index d1a6eeffee..74fed2f3e9 100644 --- a/public/static/docs/get-started/agenda.md +++ b/public/static/docs/learn/get-started/agenda.md @@ -1,5 +1,9 @@ # Agenda +You'll need [Git](https://git-scm.com) to run the commands in this guide. Also, +if DVC is not installed, please follow these [instructions](/doc/install) to do +so. + In the next few sections we'll build a simple natural language processing (NLP) project from scratch. If you'd like to get the final result or have any issues along the way, you can download the fully reproducible @@ -13,10 +17,9 @@ Otherwise, bear with us and we'll introduce some basic DVC concepts to get the same results together! The idea for this project is a simplified version of our -[Deep Dive Tutorial](/doc/tutorials/deep). It explores the NLP problem of -predicting tags for a given StackOverflow question. For example, we might want a -classifier that can classify (or predict) posts about Python by tagging them -with `python`. +[Deep Dive Tutorial](/doc/learn/deep). It explores the NLP problem of predicting +tags for a given StackOverflow question. For example, we might want a classifier +that can classify (or predict) posts about Python by tagging them with `python`. ![](/static/img/example-flow-2x.png) diff --git a/public/static/docs/get-started/compare-experiments.md b/public/static/docs/learn/get-started/compare-experiments.md similarity index 94% rename from public/static/docs/get-started/compare-experiments.md rename to public/static/docs/learn/get-started/compare-experiments.md index d23b3ff78b..b8892ff803 100644 --- a/public/static/docs/get-started/compare-experiments.md +++ b/public/static/docs/learn/get-started/compare-experiments.md @@ -17,7 +17,7 @@ $ dvc repro evaluate.dvc `git checkout master` and `dvc checkout` commands ensure that we have the latest experiment code and data respectively. And `dvc repro`, as we discussed in the -[Reproduce](/doc/get-started/reproduce) chapter, is a way to run all the +[Reproduce](/doc/learn/get-started/reproduce) chapter, is a way to run all the necessary commands to build the model and measure its performance. ```dvc diff --git a/public/static/docs/get-started/configure.md b/public/static/docs/learn/get-started/configure.md similarity index 100% rename from public/static/docs/get-started/configure.md rename to public/static/docs/learn/get-started/configure.md diff --git a/public/static/docs/get-started/connect-code-and-data.md b/public/static/docs/learn/get-started/connect-code-and-data.md similarity index 92% rename from public/static/docs/get-started/connect-code-and-data.md rename to public/static/docs/learn/get-started/connect-code-and-data.md index 0cece0c266..057407b751 100644 --- a/public/static/docs/get-started/connect-code-and-data.md +++ b/public/static/docs/learn/get-started/connect-code-and-data.md @@ -62,8 +62,7 @@ $ git commit -m "Add source code files to repo" Having installed the `src/prepare.py` script in your repo, the following command transforms it into a reproducible [stage](/doc/command-reference/run) for the ML -pipeline we're building (described in the -[next chapter](/doc/tutorials/pipelines)). +pipeline we're building (described in the [next chapter](/doc/learn/pipelines)). ```dvc $ dvc run -f prepare.dvc \ @@ -74,8 +73,8 @@ $ dvc run -f prepare.dvc \ `dvc run` generates the `prepare.dvc` DVC-file. It has the same [format](/doc/user-guide/dvc-file-format) as the file we created in the -[previous section](/doc/get-started/add-files) to track `data.xml`, except in -this case it has additional information about the `data/prepared` output (a +[previous section](/doc/learn/get-started/add-files) to track `data.xml`, except +in this case it has additional information about the `data/prepared` output (a directory where two files, `train.tsv` and `test.tsv`, will be written to), and about the Python command that is required to build it. @@ -121,8 +120,9 @@ wdir: . ``` > `dvc run` is just the first of a set of DVC command required to generate a -> [pipeline](/doc/get-started/pipeline), or in other words, instructions on how -> to build a ML model (data file) from previous data files (or directories). +> [pipeline](/doc/learn/get-started/pipeline), or in other words, instructions +> on how to build a ML model (data file) from previous data files (or +> directories). Let's briefly mention what the command options used above mean for this particular example: diff --git a/public/static/docs/get-started/experiments.md b/public/static/docs/learn/get-started/experiments.md similarity index 100% rename from public/static/docs/get-started/experiments.md rename to public/static/docs/learn/get-started/experiments.md diff --git a/public/static/docs/get-started/import-data.md b/public/static/docs/learn/get-started/import-data.md similarity index 83% rename from public/static/docs/get-started/import-data.md rename to public/static/docs/learn/get-started/import-data.md index d911d3c0c9..59da9f1ce1 100644 --- a/public/static/docs/get-started/import-data.md +++ b/public/static/docs/learn/get-started/import-data.md @@ -1,9 +1,9 @@ # Import Data -We've seen how to [push](/doc/get-started/store-data) and -[pull](/doc/get-started/retrieve-data) data from/to a DVC project's -[remote](/doc/command-reference/remote). But what if we wanted to integrate a -dataset or ML model produced in one project into another one? +We've seen how to [push](/doc/learn/get-started/store-data) and +[pull](/doc/learn/get-started/retrieve-data) data from/to a DVC +project's [remote](/doc/command-reference/remote). But what if we wanted +to integrate a dataset or ML model produced in one project into another one? One way is to manually download the data (with `wget` or `dvc get`, for example) and use `dvc add` to track it, but the connection between the projects would be @@ -11,7 +11,7 @@ lost. We wouldn't be able to tell where the data came from or whether there are new versions available. A better alternative is the `dvc import` command: