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

Include Documentation link in UI navigation #302

Open
shreddedbacon opened this issue Oct 14, 2024 · 1 comment
Open

Include Documentation link in UI navigation #302

shreddedbacon opened this issue Oct 14, 2024 · 1 comment

Comments

@shreddedbacon
Copy link
Member

shreddedbacon commented Oct 14, 2024

It might be nice to include a link to documentation in the UI

Something like this maybe? Or maybe in the drop down menu?
Untitled

The build-deploy-tool was updated to include a documentation URL variable which defaults to https://docs.lagoon.sh. It might be nice to do something similar for the UI, this variable could then be used for any documentation references that the UI may currently have. For amazeeio we would be able to set this to https://docs.amazee.io/lagoon-documentation/ instead of the default.

@shreddedbacon
Copy link
Member Author

shreddedbacon commented Oct 14, 2024

It might also be useful to include references to specific pages in the documentation on certain pages in the UI
For example, when on the organizations overview page, it might be useful to provide a help link to ${DOCSURL}/interacting/organizations/ somewhere on the page like this?
image

Edit: Or maybe somewhere else on the page as a little Help (?) button

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

No branches or pull requests

1 participant