Navbar Customization - Nav links for About and Guides

[mheppler]

Based on feedback from the community (#2003), we will provide configurable settings to allow for the customization of the following features in the Dataverse application's navbar:

• Name: branding needs to be more flexible (out of scope, delivered in Customizable dataverse names #3611)
• Logo: display a logo in the navbar in place of orange Dataverse logo (Moving to Customization Header/Footer/Homepage - Optional new landing page for installation #3639 as this will be an external file)
• About link: configurable link to an installation's custom project site
  • By default, the About link in the navbar is turned off, installations config the URL to display it
• Guides links: configurable link to an installation's custom version of guides (as suggested in Installation Customization - Configurable Navbar Link for User Guides #2831, delivered as part of Not easy to preview changes to User Guide and API Guide in development #3540 55fc128)
  • only User Guide in navbar, other guides will be linked from Dataverse.org

[djbrooke]

Thanks for creating this one, @mheppler. Should we close #2831?

[mheppler]

@djbrooke done

[pdurbin]

With regard to customization of links to the Guides, we should probably consider not only #2831 but also #2832 which is a bit different.

[dlmurphy]

Last month the Design team put together a document summarizing research insights that can help inform this feature:
https://docs.google.com/a/harvard.edu/document/d/17GqVnhUw8glb0ikQ5pYX07ed5LEs2M5LYZkAkuNvUnI/edit?usp=sharing

Stuff that jumps out to me:

1. If Guides links are configurable in the navbar, users might be directed to the wrong guides in notifications.

These notifications include links to the User Guide:

• Account creation notification & email
• New Dataverse creation notification & email
• New Dataset creation notification & email

These site messages include links to the User Guide:

• When you limit a search to the point where there are zero results, a message directs you to the User Guide.

One solution would be: if an installation uses a custom URL for its guides, these custom URLs are automatically populated in all Dataverse notifications as well.

2. In this Google Group post, someone requested the ability to add a “Blog” link to the navbar that led to their institution’s blog. Should installations be able to add new links to their navbars?

[raprasad]

The following navbar link updates are included:

• The "About" link no longer shows up by default. To make the link available, set a url using the setting :NavbarAboutUrl
• "Guides" is no longer a dropdown. Instead there is a single link to a "User Guide."
  • As of release 4.6.1 (55fc128), this link is configurable via the settings:
    • :GuidesBaseUrl
    • :GuidesVersion.
    • For details, see: http://guides.dataverse.org/en/4.6.1/installation/config.html?highlight=guidesversion

/cc @shlake

[mheppler]

Concerns regarding the notifications in comment above from @dlmurphy have been reviewed with the changes from @pdurbin and it looks like all User Guides links are properly pointing to the correct hosted guide and version, as set in the configurations.

There is also the open issue "Notifications: Ability to modify included text" #2710 from @shlake that looks at the notifications in more detail.

[sekmiller]

Code looks good. Passing to QA. There's still a file called 'navbar.html' that doesn't seem to be used currently. It should probably be deleted from the project at some point.

[sekmiller]

Also, branch is a couple of commits behind dev at the moment. It needs another update.

[mheppler]

@sekmiller I will update the branch now with develop.

Re:navbar.html -- I think that file you are referencing is only part of the UI for the docs, and not the app.

[pdurbin]

I ran the code locally as of 32a90dd and it looks good. I fixed the title of this issue since the stated scope has decreased (nothing about the logo anymore) but a note from @raprasad to @kcondon (or a conversation) would be appreciated since I noticed many changes of settingsService to settingsWrapper like this:

• settingsWrapper.getValueForKey(SettingsServiceBean.Key.ComputeBaseUrl) + getSwiftContainerName()
• settingsWrapper.isTrueForKey(SettingsServiceBean.Key.DatasetPublishPopupCustomTextOnAllVersions, false);
• signupAllowed = settingsWrapper.isTrueForKey(SettingsServiceBean.Key.AllowSignUp, safeDefaultIfKeyNotFound);
• etc, etc.

These are welcome performance improvements so I'll add the appropriate GitHub label.