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

Add link to Documentation from within DSpace User Interface #3320

Open
tdonohue opened this issue Sep 11, 2024 · 0 comments
Open

Add link to Documentation from within DSpace User Interface #3320

tdonohue opened this issue Sep 11, 2024 · 0 comments
Labels
affects: main Issue impacts "main" (latest release). affects: 7.x Issue impacts 7.x releases affects: 8.x Issue impacts 8.x releases documentation Ticket describes improvements or additions to documentation help wanted Needs a volunteer to claim to move forward improvement usability

Comments

@tdonohue
Copy link
Member

Description

We should provide a link to the DSpace "User Documentation" from within the DSpace User Interface. This might be simply a link in the Admin Sidebar which links back to the Learning DSpace documentation.

The purpose of this link it to provide DSpace users (especially administrators) a way to find the corresponding DSpace documentation.

This link needs to be slightly different per release. For example, the 7.x version of the UI should link to the 7.x version of the docs, while the 8.x version of the UI should link to the 8.x version of the docs. We also may want to make it possible to easily customize (perhaps the URL should be a configuration?) so that sites can link it to their own custom documentation.

Related Work

Eventually, it'd be even better if we could add more Contextual Help Tooltips which can link users directly to specific areas of the Documentation for tips/tricks. However, at this time we have very few of these contextual tooltips.

Related to #2263
Related also to #2030 (where tooltips were first created)

@tdonohue tdonohue added improvement help wanted Needs a volunteer to claim to move forward usability documentation Ticket describes improvements or additions to documentation affects: main Issue impacts "main" (latest release). affects: 8.x Issue impacts 8.x releases affects: 7.x Issue impacts 7.x releases labels Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects: main Issue impacts "main" (latest release). affects: 7.x Issue impacts 7.x releases affects: 8.x Issue impacts 8.x releases documentation Ticket describes improvements or additions to documentation help wanted Needs a volunteer to claim to move forward improvement usability
Projects
Development

No branches or pull requests

1 participant