dataverse icon indicating copy to clipboard operation
dataverse copied to clipboard

No home button to navigate to home page of guides

Open pdurbin opened this issue 1 year ago • 0 comments

It's been observed many times (most recently by the Documentation Working Group) that there is no way to navigate to the home page of the guides.

Clicking the "Dataverse Project" icon and link at the top left...

Screenshot 2024-10-19 at 10 35 59 AM

... sends you to https://dataverse.org

Instead, clicking whatever is at the top left (maybe it should say something like "Dataverse Guides" instead) should probably send you to https://guides.dataverse.org/en/latest/index.html or https://guides.dataverse.org/en/6.4/index.html depending on which version you are browsing. That top left area is the conventional place for a "home" button.

A quick but suboptimal fix is a change to source/_templates/navbar.html like this:

% git diff
diff --git a/doc/sphinx-guides/source/_templates/navbar.html b/doc/sphinx-guides/source/_templates/navbar.html
index d88306be8a..a4ad3c9845 100644
--- a/doc/sphinx-guides/source/_templates/navbar.html
+++ b/doc/sphinx-guides/source/_templates/navbar.html
@@ -15,7 +15,7 @@
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
             </button>
-            <a class="navbar-brand" href="https://dataverse.org" id="dataverse-org-homepage-url">Dataverse Project</a>
+            <a class="navbar-brand" href="https://guides.dataverse.org" id="dataverse-org-homepage-url">Dataverse Guides</a>
         </div>

This would change "Dataverse Project" to "Dataverse Guides"...

Screenshot 2024-10-19 at 10 51 55 AM

... and change the link to https://guides.dataverse.org but I say this is suboptimal because you will always be redirected to "latest" ( https://guides.dataverse.org/en/latest/ ) rather that whatever version you are on such as 6.4 ( https://guides.dataverse.org/en/6.4/ ).

Notes:

  • source/_static/navbar_from_dataverse_org.js seems to no longer be used as of d989a26ebd646b2b52e92b178de1d9b1ea9686a9 and can probably be deleted.

pdurbin avatar Oct 19 '24 14:10 pdurbin