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.

Sign up for GitHub

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

Jump to bottom

start: clean up pages (Experiments) #3956

Merged
merged 6 commits into from
Sep 22, 2022
Merged

start: clean up pages (Experiments) #3956

merged 6 commits into from
Sep 22, 2022

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented Sep 15, 2022 •
edited
Loading

@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start labels Sep 15, 2022
@jorgeorpinel jorgeorpinel mentioned this pull request Sep 15, 2022
Merged
1 task
@shcheklein shcheklein temporarily deployed to dvc-org-start-pages-exp-tfyhfk September 15, 2022 16:40 Inactive
@github-actions
Copy link
Contributor

Link Check Report

All 1 links passed!

@shcheklein
Copy link
Member

Tbh, I don' feel the motivation behind this. It complicates things even further. What would be more reasonable is to take the whole page and move as child - as-is (name it "Intro" or somehow else). Since both pages contain content of the same level. And there is no need in having an index I think.

@jorgeorpinel
Copy link
Contributor Author

take the whole page and move as child - as-is

OK, moved as-is to https://dvc-org-start-pages-exp-tfyhfk.herokuapp.com/doc/start/experimentation/experiments now.

@jorgeorpinel jorgeorpinel marked this pull request as ready for review September 20, 2022 21:26
@shcheklein shcheklein temporarily deployed to dvc-org-start-pages-exp-tfyhfk September 20, 2022 21:26 Inactive
jorgeorpinel
jorgeorpinel commented Sep 20, 2022
View reviewed changes
content/docs/start/experimentation/experiments.md Outdated
Comment on lines 2 to 5
title: 'Get Started: Experiments'
description: 'Get started with experiment management in DVC. Learn how to
capture multiple project versions automatically without bloating the Git repo.
Iterate quickly by comparing them easily and finding best performers.'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, I did add a SEO description but this is not visible.

@shcheklein shcheklein temporarily deployed to dvc-org-start-pages-exp-tfyhfk September 20, 2022 21:30 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-start-pages-exp-tfyhfk September 20, 2022 21:32 Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Sep 20, 2022 •
edited
Loading

f3cd31f

Link Check Report

There were no links to check!

CML watermark

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Sep 21, 2022 •
edited
Loading

Curious about your opinion too @dberenbaum . Both this PR and #3955 are approved but the approach in each one was different: that one keeps the Data Management index page while this one does not keep an Exp Mgmt index page (it's just an empty nav entry).

Pros:

  • Less pages to maintain
  • User goes straight into the action

Cons:

  • The empty nav entry probably doesn't influence SEO as an actual page could
  • The index page could be used to summarize the trail + emphasize that it's comprehensive (covers all applicable DVC features)

@jorgeorpinel jorgeorpinel mentioned this pull request Sep 21, 2022
Merged
@jorgeorpinel
Copy link
Contributor Author

OK well I'm going to merge this for now. All the redirects are 302s anyway, we can revisit.

@jorgeorpinel jorgeorpinel merged commit f3cd31f into main Sep 22, 2022
@jorgeorpinel jorgeorpinel deleted the start/pages/exps branch September 22, 2022 18:27
@dberenbaum
Copy link
Contributor

Sorry, I missed this mention. No strong opinion on whether to have an index page. LGTM.

@jorgeorpinel jorgeorpinel mentioned this pull request Sep 27, 2022
Merged
@jorgeorpinel
Copy link
Contributor Author

Rel. #4000

jorgeorpinel added a commit that referenced this pull request Sep 28, 2022
@jorgeorpinel @restyled-io @restyled-commits
start: update links (Experiment Management) (#3974)
6a12014 
* start: Experimentation/ Experiiments

* start: move whole experiments page as-is under empty index
per #3956 (comment)

* start: add meta description to Exps page

* start: rename Experimentation to Exp Mgmt

* start: restore unrelated file

* start: update Exp Mgmt links

* Restyled by prettier (#3986)

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>
@jorgeorpinel jorgeorpinel added the type: enhancement Something is not clear, small updates, improvement suggestions label Nov 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shcheklein shcheklein shcheklein approved these changes

Assignees
No one assigned
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

start: less content in sub-index pages
3 participants
@jorgeorpinel @shcheklein @dberenbaum