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
Add setting for navbar guide URL override #6877
Comments
Thanks @poikilotherm. Just so I understand correctly, is your use case similar to Libradata (https://dataverse.lib.virginia.edu/) or is it different? cc: @shlake |
I think it's different (from what I see at their site). We offer all the guides, too, so we use the Please feel free to try for yourself 😄 (the guide is not finished yet, but we're getting there...) |
@poikilotherm we use the :GuidesBaseURL setting for the "User Guide" link on the navbar and use :NavbarAboutURL for the "About" link. I have customized the default Harvard User Guides, so UVa's look like Harvard's, uses sphinx, with UVa specific information - see account information: http://uvalib.github.io/dataverse-docs/en/current/user/account.html |
Nice! We didn't want to fork and change the user guide directly, but instead we use the upstream as a submodule and add the pages. I created another section parallel to the others, so this is not reachable via the We went for using a distinct section because we want to elaborate on a few things and feared those might get a little lost in the very complex and detailed user guide. |
@poikilotherm I looked at your commit above and I think I get what you want. From the header, you don't want to link to "/user". You want to link to "/juelich", which is, of course, specific to your institution. You made the code in that header backward compatible, as you said and from what I can tell. Great. The main reason I'm writing is that I'm wondering about all the other places where the URL to the guides is used. I'll dump a couple screenshots below to show what I mean. I'm wondering if you're aware of all these usages and if you're fine leaving the code alone for these. Finally, good catch to finding an used database setting! |
Howdy @pdurbin ! Yeah, those places were the things I meant with "help button links" in my 2nd comment. I am fine with those, I simply created a rewrite rule in NGINX. But obviously that rule cannot change the target when clicking on the navbar link to the specialized guide, that's why I went for the option... 😉 Should I wait for a notification by @TaniaSchlatter or others from the UI team or should I just craft a PR? If the UI team wants to take a look at how this looks and feels, feel free to go to https://data.fz-juelich.de |
@poikilotherm thanks, here are a couple screenshots I took. I clicked "User Guide". |
Looks great, @poikilotherm. Thanks. Also, lovely typeface on your guide. |
@TaniaSchlatter Wait till you see it on our installations, too 😄 Then I'll go ahead and do some magic to summon a pull request. |
Back in #3637, a database setting "NavbarGuidesURL" has been added to
SettingsServiceBean
, but was never used.I would like to pick this up (and document it) for a use case in Jülich DATA. We have a custom guide based on your magnificent work, which includes a guide for the special needs and processes in our instance. We would like to link to this section of the guide in the navigation bar instead of the user guide.
The code for this is very simple. It provides a fallback to a sane default.
Please tell me what you think and if I should create a PR for this very simple change.
Pinging @TaniaSchlatter for being UI related.
The text was updated successfully, but these errors were encountered: