start: reader instructions (in index pages) #4000
Conversation
jorgeorpinel
added
type: enhancement
jorgeorpinel
changed the title
jorgeorpinel
force-pushed
the
start/instructions
branch
from
4bee8de
to
9d7bc7e
Compare
Link Check ReportAll 5 links passed!
|
jorgeorpinel
changed the title
content/docs/start/index.md
Outdated
| or import a model to another project. | ||
| - **[Data and model access]** goes over using data artifacts from outside of the | ||
| project and importing them from another DVC project. This can help to download | ||
| a specific version of an ML model to a deployment server or import a model to |
There was a problem hiding this comment.
Updated some of these descriptions to match the cards at the bottom of the trail index pages.
content/docs/start/index.md
Outdated
| ### ⚙️ Expand to prepare a project. | ||
|
|
||
| We'll be building an NLP project from scratch together. The end result is | ||
| published on [GitHub](https://github.com/iterative/example-get-started) -- feel | ||
| free to clone the repo. | ||
|
|
||
| Let's start with `git init`: | ||
| Imagine we want to building an ML project from scratch. Let's start by creating | ||
| a Git repository: | ||
|
|
||
| ```dvc | ||
| $ mkdir example-get-started | ||
| $ cd example-get-started | ||
| $ git init | ||
| ``` | ||
|
|
||
| <admon type="info"> | ||
|
|
||
| This name is actually used in our | ||
| [example-get-started](https://github.com/iterative/example-get-started) repo. | ||
|
|
||
| </admon> |
There was a problem hiding this comment.
I also realized this is only applicable to the Data Mgmt trail now, so I updated the note here (made it more general) and added hidden tips about each example repo into the trail index pages (context: #2496 (comment)).
| The steps and results of some of these chapters are captured in our | ||
| [example-get-started] repo on GitHub. Feel free to clone it and `git checkout` | ||
| any of it's [tags] to explore further. | ||
|
|
||
| [example-get-started]: https://github.com/iterative/example-get-started | ||
| [tags]: https://github.com/iterative/example-get-started/tags |
There was a problem hiding this comment.
Should we maybe turn the tags that correspond to certain chapters and sections into Releases in the GH repo? I.e. from some https://github.com/iterative/example-get-started/tags to https://github.com/iterative/example-get-started/releases in this case. May be easier to mention releases than all the tags (not so easy to explore and match to the GS).
There was a problem hiding this comment.
Sorry for stressing it one more time, but I think we are optimizing things that are not very important.
Re the PR - can we also simplify it? do an a common one paragraph description that is common for all trails? It feels sad that we need to explain in such length. Get started should be self-descriptive, simple, etc.
jorgeorpinel
added
the
p2-nice-to-have
shcheklein
had a problem deploying
to
dvc-org-start-instructi-ju4fni
✅ dvc.org-2022-test-main deploy preview ready
|
This comment was marked as off-topic.
This comment was marked as off-topic.
|
Btw, I think |
Small improvement per #4000 (comment)
|
Good observation @shcheklein . PTAL at #4197. |
* start: reader instructions (2) Small improvement per #4000 (comment) * Update content/docs/start/index.md * Restyled by prettier (#4198) Co-authored-by: Restyled.io <commits@restyled.io> Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com> Co-authored-by: Restyled.io <commits@restyled.io>
Per #1943 (comment):
In review app: ⏳
Jump to #4000 (comment)