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

Fix "Get Started" walkthrough typos and outdated mentions #4118

Merged
merged 3 commits into from
Jun 15, 2023

Conversation

julieg18
Copy link
Contributor

Was reviewing the walkthrough and spotted some typos plus a couple outdated links/sentences

@@ -30,7 +30,7 @@
[python api]: https://dvc.org/doc/api-reference
[free course]: https://learn.iterative.ai/
[contribute]: https://dvc.org/doc/contributing/core
[example project]: https://github.com/iterative/example-get-started
[example project]: https://github.com/iterative/example-dvc-experiments
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe we want to direct users to example-dvc-experiments instead of example-get-started

Copy link
Member

Choose a reason for hiding this comment

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

I am not sure if this is correct or if it should now be https://github.com/iterative/example-get-started-experiments. Probably best to ask @shcheklein / @dberenbaum.

Copy link
Member

Choose a reason for hiding this comment

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

Fine to make this change and follow up

Copy link
Member

Choose a reason for hiding this comment

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

and there are multiple instances of this repo being linked to.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Links have been updated!


<p align="center">
<img src="images/plots-view-icon.png"
alt="Plots View Icon" />
</p>

The **Plots Dashboard** can be configured and accessed from the _Plots_ and
_Experiments_ side panels in the [**DVC View**](command:views.dvc-views).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Plots is no longer a link in the Experiments side panel.

@@ -36,6 +37,6 @@ If DVC and the extension are initialized, side bar will expose multiple views:
columns.
- `PLOTS`. Used to fine-tune the plots dashboard, e.g. by toggling plots
visibility.
- `FILTER BY`. Used to view, add, or remove metrics and parameters filters.
- `FILTER BY`. Used to view, add, or remove metrics/parameters filters. These
will hide specific experiments in the table.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Could be wrong but I think the mention about hiding experiments should be in the filter by section. I don't think sorting hides experiments 🤔

@julieg18 julieg18 marked this pull request as ready for review June 14, 2023 23:25
@julieg18 julieg18 enabled auto-merge (squash) June 15, 2023 16:04
@codeclimate
Copy link

codeclimate bot commented Jun 15, 2023

Code Climate has analyzed commit ba87f37 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (85% is the threshold).

This pull request will bring the total coverage in the repository to 95.2% (0.1% change).

View more on Code Climate.

@julieg18 julieg18 merged commit 680877e into main Jun 15, 2023
@julieg18 julieg18 deleted the fix-walkthrough-typos branch June 15, 2023 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants