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

Give guides a home button (and more) by removing custom navbar #10942

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from

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/

What this PR does / why we need it:

The Documentation Working Group has been talking about how there's no "home" button when clicking around the guides.

This pull request takes a somewhat bold approach of removing the custom navbar entirely. The following changes can be observed:

  • restores the default "home" button for guides (clicking "Dataverse" at top left)
  • restores "next" and "previous" links for each page (see Previous/Next navigation links in dev guide #2163)
  • restores "source" button for each page (.rst or .md)
  • old custom navbar is completely gone (see screenshots below)

Which issue(s) this PR closes:

Special notes for your reviewer:

This is a draft. At minimum, I think I also want to remove the following unused cruft:

  • source/_static/navbar_from_dataverse_org.js

There's probably CSS that can be removed as well, as well as other files or at least lines.

Suggestions on how to test this:

Try the preview link above.

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

Yes. See before and after below.

Before

Screenshot 2024-10-19 at 11 29 32 AM

After

Screenshot 2024-10-19 at 11 29 38 AM

After ("Site" dropdown)

Screenshot 2024-10-19 at 11 29 43 AM

After ("Page" dropdown)

Screenshot 2024-10-19 at 11 29 48 AM

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

Yes, not yet included.

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

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.

No home button to navigate to home page of guides
1 participant