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

Consolidate exp docs #5175

Merged
merged 4 commits into from
Mar 6, 2024
Merged

Consolidate exp docs #5175

merged 4 commits into from
Mar 6, 2024

Conversation

dberenbaum
Copy link
Contributor

@dberenbaum dberenbaum commented Mar 6, 2024

Follow up to #5173.

Consolidates experiment docs consistent with what #5133 did for model registry. See this discussion where this docs structure is suggested:

  • Use case - overview, why a MR, why ours

  • Get started - quick intro to learn how to use MR

  • Studio guide - in-depth info

This PR adopts that structure for experiments and drops additional pages like https://dvc.org/doc/studio/experiments and https://dvc.org/doc/studio/experiments.

After this PR, the docs structure should at least be semi-consistent, making it easier if we eventually come back to issues like #5153.

@dberenbaum dberenbaum requested a review from a team as a code owner March 6, 2024 14:23
@shcheklein shcheklein temporarily deployed to dvc-org-exp-consolidati-eonmjl March 6, 2024 14:26 Inactive
@dberenbaum dberenbaum temporarily deployed to dvc-org-exp-consolidati-eonmjl March 6, 2024 14:35 Inactive
Copy link
Contributor

github-actions bot commented Mar 6, 2024

Link Check Report

All 8 links passed!

Copy link
Member

@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.

please check the link that it was complaining about.

@dberenbaum dberenbaum temporarily deployed to dvc-org-exp-consolidati-eonmjl March 6, 2024 17:34 Inactive
@dberenbaum dberenbaum merged commit aa4f6b4 into exp-auto-push Mar 6, 2024
5 checks passed
@dberenbaum dberenbaum deleted the exp-consolidation branch March 6, 2024 18:25
dberenbaum added a commit that referenced this pull request Mar 6, 2024
* document env vars

* wip add document exp auto push

* guide: include exp auto push

* write exp sharing using auto push by default

* revert change to studio/experiments

* redirect links

* consolidate exp docs

* update MR link

* fix link

* Consolidate exp docs (#5175)

* consolidate exp docs

* update MR link

* fix link

* add links to creating project
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.

2 participants