Skip to content

update docs/start/experiments.md#1511

Merged
jorgeorpinel merged 6 commits into
treeverse:masterfrom
utkarshsingh99:patch13
Jul 3, 2020
Merged

update docs/start/experiments.md#1511
jorgeorpinel merged 6 commits into
treeverse:masterfrom
utkarshsingh99:patch13

Conversation

@utkarshsingh99
Copy link
Copy Markdown
Contributor

@utkarshsingh99 utkarshsingh99 commented Jun 29, 2020

  • ❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

  • 🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

  • Please choose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏
Fix #1508
@shcheklein @jorgeorpinel

Comment thread content/docs/start/experiments.md Outdated
Comment thread content/docs/start/experiments.md Outdated
Comment thread content/docs/start/experiments.md Outdated
Comment thread content/docs/start/experiments.md Outdated
Comment thread content/docs/start/experiments.md Outdated
Copy link
Copy Markdown
Contributor

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! please, take a look ...at this moment it's quite repetitive and should be restructured a bit.

@utkarshsingh99
Copy link
Copy Markdown
Contributor Author

I tried omitting certain parts which were probably too much detail for someone getting started.
Although, I wasn't able to locate the exact places the cache info is being repeated so wasn't sure what exactly I had to omit.
But I made the content more relevant to its placement and linked it to more about dvc run options.
@shcheklein

Comment thread content/docs/start/experiments.md Outdated
Comment thread content/docs/start/experiments.md Outdated
Comment thread content/docs/start/experiments.md Outdated
@jorgeorpinel
Copy link
Copy Markdown
Contributor

jorgeorpinel commented Jul 2, 2020

Hey @utkarshsingh99, I'll take over reviewing this PR. BTW, let's do just 1 PR at a time, please — so I'll focus on this one only for now (you have #1494 also).

I wasn't able to locate the exact places the cache info is being repeated

It is/was all inside that expandable section. The paragraph explaining the options is repetitive with the later note about cache: false right now. I left specific comments about how to fix that though.

Also, I deployed this to https://dvc-landing-patch13-q0vmux9res.herokuapp.com/doc/start/experiments

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-patch13-q0vmux9res July 2, 2020 01:26 Inactive
@shcheklein shcheklein temporarily deployed to dvc-landing-patch13-q0vmux9res July 2, 2020 05:51 Inactive
Comment thread content/docs/start/experiments.md Outdated
Comment thread content/docs/start/experiments.md Outdated
Copy link
Copy Markdown
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just one last small suggestion left ☝️

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-patch13-q0vmux9res July 3, 2020 18:52 Inactive
@jorgeorpinel jorgeorpinel merged commit e0c4316 into treeverse:master Jul 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

get-started: cache: false explanation

3 participants