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

No home button to navigate to home page of guides #10941

Open
pdurbin opened this issue Oct 19, 2024 · 0 comments · May be fixed by #10942
Open

No home button to navigate to home page of guides #10941

pdurbin opened this issue Oct 19, 2024 · 0 comments · May be fixed by #10942

Comments

@pdurbin
Copy link
Member

pdurbin commented Oct 19, 2024

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 d989a26 and can probably be deleted.
pdurbin added a commit that referenced this issue Oct 19, 2024
- restores the default "home" button for guides
- restores "next" and "previous" links for each page
- restores "source" button for each page (.rst or .md)
pdurbin added a commit that referenced this issue Oct 19, 2024
This was hidden before because a custom navbar took over.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant