Bug 784039

Summary:	RFE: provide hyperlinks to documentation
Product:	[Retired] Beaker	Reporter:	Jeff Moyer <jmoyer>
Component:	web UI	Assignee:	beaker-dev-list
Status:	CLOSED WONTFIX	QA Contact:
Severity:	low	Docs Contact:
Priority:	low
Version:	0.8	CC:	bpeck, mastyk, mcsontos, stl, tools-bugs
Target Milestone:	---	Keywords:	FutureFeature, Triaged
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:	UX
Fixed In Version:		Doc Type:	Enhancement
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2020-06-02 11:59:37 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Jeff Moyer 2012-01-23 16:21:45 UTC

Hi,

It is not immediately clear to me what the meanings of the following are:

Condition: Manual, Automated, Broken, Removed (well, the last two are easy to understand, the former two need clarification)

Shared -- not clear whether this means the system will be shared with the world, or just shared with groups in the acl.

By providing links to help, it saves time digging around for documentation.

Thanks in advance!

Comment 2 Nick Coghlan 2014-11-20 06:55:44 UTC

Bug 1165960 is another case where a hyperlink might be useful - in that case, from the Reserve Workflow page in the web UI to the docs for the new "bkr reserve-workflow" CLI subcommand.

However, linking back to the upstream beaker-project.org website isn't particularly desirable.

Instead, it may be worth following Bugzilla's lead, and deploying the built HTML documentation *on the main Beaker server*.

Then the web UI can just link locally to those docs, rather than to the upstream site.

Actually doing that would require appropriate updates to the build process, updating the default configuration for the main server, and changes to the developer's guide to provide recommendations on how to maintain hyperlinks between the web UI and the documentation.

Comment 3 Tomas Klohna 🔧 2019-04-04 17:24:15 UTC

I actually disagree with Nick here. The upstream site should always be promoted considering it contains all other crucial info for users anyway.

Comment 4 Martin Styk 2020-06-02 11:59:37 UTC

Hello,

thank you for opening issue in Beaker project.
This issue was marked with component "web ui".
As we are not planning to address any further issues in current UI, due to technical stack and not being able to work with Python 3 codebase, I'm closing this issue as WONTFIX.
New UI will be reimplemented within new versions of Beaker.

If you have any questions feel free to reach out to me.

Best regards,
Martin <martin.styk>