Skip to content

Comments

Guides: improve navigation#10942

Merged
ofahimIQSS merged 14 commits intodevelopfrom
10941-remove-custom-guides-navbar
Apr 30, 2025
Merged

Guides: improve navigation#10942
ofahimIQSS merged 14 commits intodevelopfrom
10941-remove-custom-guides-navbar

Conversation

@pdurbin
Copy link
Member

@pdurbin pdurbin commented Oct 19, 2024

Note: you can preview this pull request at https://dataverse-guide--10942.org.readthedocs.build/en/10942/

You can compare it with https://guides.dataverse.org/en/latest/

What this PR does / why we need it:

The Documentation Working Group observed that there's no "home" button for the guides. I started by fixing this but kept going:

  • At the top "Dataverse Project" has been changed to "Dataverse Guides" and it now serves as a home button for the guides. (Previously, clicking would bring you to dataverse.org.)
  • "v6.6" (for example) in the navbar links to the "versions" page
  • Replace various links in navbar with a single "About Dataverse" link to dataverse.org
  • "Next" and "Previous" links appear at the bottom of every page
  • A "Source" link appears at the bottom of the page

Before

Screenshot 2025-03-28 at 09-38-05 Dataverse Documentation v  6 6 — Dataverse org

After

Screenshot 2025-04-14 at 11-56-08 Dataverse Documentation v  6 6 — Dataverse org

Which issue(s) this PR closes:

Special notes for your reviewer:

I'm removing the custom navbar.

Suggestions on how to test this:

Try https://dataverse-guide--10942.org.readthedocs.build/en/10942/

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Yes. See before and after screenshots above.

Is there a release notes update needed for this change?:

Yes, added.

Additional documentation:

None.

- restores the default "home" button for guides
- restores "next" and "previous" links for each page
- restores "source" button for each page (.rst or .md)
This was hidden before because a custom navbar took over.
@pdurbin
Copy link
Member Author

pdurbin commented Oct 24, 2024

Based on feedback from @DieuwertjeBloemen at https://dataverse.zulipchat.com/#narrow/channel/446770-docs/topic/no.20home.20button/near/477816742 I added "About Dataverse" to the navbar in 5c5812e. It links to dataverse.org

Here's an updated screenshot:

Screenshot 2024-10-24 at 4 59 10 PM

@pdurbin pdurbin moved this to Ready for Review ⏩ in IQSS Dataverse Project Mar 21, 2025
@pdurbin pdurbin marked this pull request as ready for review March 21, 2025 16:03
@pdurbin
Copy link
Member Author

pdurbin commented Mar 21, 2025

@ofahimIQSS @DieuwertjeBloemen @CharityEverett, and I touched on this during the documentation working group meeting this morning.

As I mentioned above, I might want to remove source/_static/navbar_from_dataverse_org.js which might be cruft.

For now Omer and I agreed to keep this going and put it on the board. I also merged the latest from develop in.

Please keep the feedback coming!

@coveralls
Copy link

Coverage Status

coverage: 22.735%. remained the same
when pulling e46762a on 10941-remove-custom-guides-navbar
into 5fbfea2 on develop.

@cmbz cmbz added the FY25 Sprint 19 FY25 Sprint 19 (2025-03-12 - 2025-03-26) label Mar 21, 2025
@pdurbin pdurbin moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Mar 24, 2025
@pdurbin pdurbin added the Size: 3 A percentage of a sprint. 2.1 hours. label Mar 24, 2025
pdurbin added 7 commits March 24, 2025 12:05
navbar_from_dataverse_org.js is no longer used, so we delete it.
It operated on navbar.html, which we deleted already.

The script was setting the site name to "Dataverse Project" and
adding the Dataverse icon next to it. We're now doing this elsewhere.
@pdurbin pdurbin changed the title Give guides a home button (and more) by removing custom navbar Guides: improve navigation Mar 28, 2025
@pdurbin pdurbin moved this from In Review 🔎 to Ready for Review ⏩ in IQSS Dataverse Project Mar 28, 2025
@cmbz cmbz added the FY25 Sprint 20 FY25 Sprint 20 (2025-03-26 - 2025-04-09) label Mar 30, 2025
@cmbz cmbz added the FY25 Sprint 21 FY25 Sprint 21 (2025-04-09 - 2025-04-23) label Apr 9, 2025
@stevenwinship stevenwinship self-assigned this Apr 22, 2025
@stevenwinship stevenwinship moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Apr 22, 2025
@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Apr 22, 2025
@stevenwinship stevenwinship removed their assignment Apr 22, 2025
@cmbz cmbz added the FY25 Sprint 22 FY25 Sprint 22 (2025-04-23 - 2025-05-07) label Apr 23, 2025
@ofahimIQSS ofahimIQSS self-assigned this Apr 29, 2025
@ofahimIQSS ofahimIQSS moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Apr 29, 2025
@ofahimIQSS
Copy link
Contributor

ofahimIQSS commented Apr 29, 2025

Anything we can do about user experience on smaller screens? I see the side nav bar intersecting with the footer when I expand content (ie. clicking on Admin Guide then reducing browser size):

image

edit: actually, this may be a bug as I can reproduce in large screen as well.
image

@pdurbin pdurbin self-assigned this Apr 30, 2025
@pdurbin
Copy link
Member Author

pdurbin commented Apr 30, 2025

@ofahimIQSS I'm pretty sure that overlap we're seeing only occurs on the ReadTheDocs preview service we use.

Check it out, the overlap also happens at https://dataverse-guide--11374.org.readthedocs.build/en/11374/admin/index.html which is a completely unrelated PR (#11374).

You could build the PR locally if you want, or with Jenkins, to avoid using the ReadTheDocs service when you're testing.

@pdurbin pdurbin removed their assignment Apr 30, 2025
@ofahimIQSS
Copy link
Contributor

Thank you for the clarification - I see no issues here. We can go ahead and merge this.

@ofahimIQSS ofahimIQSS merged commit 768fb03 into develop Apr 30, 2025
8 checks passed
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Apr 30, 2025
@ofahimIQSS ofahimIQSS deleted the 10941-remove-custom-guides-navbar branch April 30, 2025 17:52
@ofahimIQSS ofahimIQSS removed their assignment Apr 30, 2025
@pdurbin pdurbin added this to the 6.7 milestone Apr 30, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project May 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY25 Sprint 19 FY25 Sprint 19 (2025-03-12 - 2025-03-26) FY25 Sprint 20 FY25 Sprint 20 (2025-03-26 - 2025-04-09) FY25 Sprint 21 FY25 Sprint 21 (2025-04-09 - 2025-04-23) FY25 Sprint 22 FY25 Sprint 22 (2025-04-23 - 2025-05-07) Size: 3 A percentage of a sprint. 2.1 hours.

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

No home button to navigate to home page of guides Previous/Next navigation links in dev guide

6 participants