Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

start: provide code samples, make it more actionable #1943

Closed
1 of 2 tasks
gurobokum opened this issue Nov 14, 2020 · 7 comments
Closed
1 of 2 tasks

start: provide code samples, make it more actionable #1943

gurobokum opened this issue Nov 14, 2020 · 7 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start status: stale You've been groomed! type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@gurobokum
Copy link
Contributor

gurobokum commented Nov 14, 2020

It would be great that every chapter of Get Start provides instruction how to prepare a needful repo structure to proceed further
At this moment it's hard to init needful structure if you start not from the first chapter

In one chapter such approach is applied - https://dvc.org/doc/start/data-management/data-pipelines

Expand to download example code.

  • but it's not enough and the user needs to do few additional steps to proceed further:
  • run git init, covered with Please also add or commit the source code directory with Git at this point
  • run dvc init
  • fetch data/data.xml

Providing at the start of every chapter the steps how to initialize the repo will make chapters independent and help to avoid few errors

@jorgeorpinel jorgeorpinel added type: discussion Requires active participation to reach a conclusion. 🐛 type: bug Something isn't working. type: enhancement Something is not clear, small updates, improvement suggestions and removed type: discussion Requires active participation to reach a conclusion. labels Nov 16, 2020
@jorgeorpinel
Copy link
Contributor

instruction how to prepare a needful repo structure to proceed further

Yeah, we used to have this in the previous version of the GS. Not sure why we no longer have those since it can be hidden in an expandable section indeed. Let's do this unless you remember a reason for this @shcheklein ?

Also if I would like to proceed Experiments chapter I need to have model.pkl there. But adding model.pkl is marked optional in the previous chapter

Also true, we should definitely address this part. Could be addressed by the same solution like Guro mentioned.

@shcheklein shcheklein added type: discussion Requires active participation to reach a conclusion. status: research Writing concrete steps for the issue and removed 🐛 type: bug Something isn't working. labels Nov 16, 2020
@shcheklein
Copy link
Member

shcheklein commented Nov 16, 2020

We had it back and forth a few times already. Doing it completely reproducible and chapters independent makes it a hands-on tutorial like (which get started is not). It means longer read time, more distractions for users who want to get the idea quick, etc.

The idea with the recent changes was to use Katacoda extensively to provide such playground (it still out of date btw, which is on of the biggest priorities).

If Katacoda is not visible we should put links into the expandable sections. It should solve this problem (we had another complain recently, btw on Discord).

Also true, we should definitely address this part. Could be addressed by the same solution like Guro mentioned.

it's not marked optional. The problem should be addressed in a similar way:

  • Change language at the very beginning, may be at the very top of every chapter. Make it super clear "how to use the get started".

@shcheklein
Copy link
Member

Also, don't forget that we have the whole project prepared - iterative/example-get-started that can be taken, any tag can be git checkout-ed and it's an ideal starting point.

@jorgeorpinel jorgeorpinel added the p1-important Active priorities to deal within next sprints label Nov 21, 2020
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Nov 21, 2020

Yes, we can just fix the specific issues Guro reported for now.

re Katacoda - Should I take over #1586 from you @shcheklein? I've moved #1400 and #670 to p0 too.

@iterative iterative deleted a comment from shcheklein Nov 21, 2020
@shcheklein

This comment was marked as outdated.

@shcheklein shcheklein changed the title Provide code samples for Get Start chapters get started: provide code samples, make it more actionable Dec 5, 2020
@jorgeorpinel jorgeorpinel mentioned this issue May 13, 2021
2 tasks
@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) and removed type: discussion Requires active participation to reach a conclusion. p1-important Active priorities to deal within next sprints status: research Writing concrete steps for the issue labels May 13, 2021
@jorgeorpinel jorgeorpinel changed the title get started: provide code samples, make it more actionable start: provide code samples, make it more actionable May 13, 2021
@iesahin iesahin added the C: start Content of /doc/start label Oct 20, 2021
@jorgeorpinel jorgeorpinel added the status: stale You've been groomed! label Mar 30, 2022
jorgeorpinel added a commit that referenced this issue Sep 27, 2022
@jorgeorpinel
Copy link
Contributor

it's not enough and the user needs to do few additional steps

Being addressed (or not) in #3998

if I would like to proceed Experiments chapter I need to have model.pkl there

No longer applicable to https://dvc.org/doc/start/experiment-management/experiments

This is done 🙂

@jorgeorpinel
Copy link
Contributor

Change language at the very beginning, may be at the very top of every chapter. Make it super clear "how to use the get started".

Hmmm well, I guess this part has not been addressed but I'm not sure it's still wanted. I've started #4000 to discuss and address this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start status: stale You've been groomed! type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

No branches or pull requests

4 participants