Bug 1581623 - [RFE] Copy "Help" tab from Template Edit also to Index page
Summary: [RFE] Copy "Help" tab from Template Edit also to Index page
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Provisioning Templates
Version: Nightly
Hardware: Unspecified
OS: Unspecified
high
low
Target Milestone: Unspecified
Assignee: satellite6-bugs
QA Contact: Roman Plevka
URL: http://projects.theforeman.org/issues...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-05-23 09:01 UTC by Stephen Wadeley
Modified: 2019-11-04 14:03 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-11-04 14:03:20 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 23717 0 None None None 2018-05-29 06:02:31 UTC

Description Stephen Wadeley 2018-05-23 09:01:03 UTC
Description of problem:

Syntax help can only be seen after you have opened a template.
It would be better if there was a button on the main template window 

under templates > 

Version-Release number of selected component (if applicable):
Red Hat Satellite (build: 6.4.0)
foreman-1.18.0.0.3-1.el7sat.noarch


Steps to Reproduce:
1.  your_satellite_FQDN/templates/provisioning_templates/10-Alterator default/edit
2. select Help tab
3. 

Actual results:

Syntax help can only be seen after you have opened a template.

Expected results:

Syntax help is generic and not template specific so should be accessible before opening a template

Comment 2 Lukas Zapletal 2018-05-23 13:58:43 UTC
Let's move it for better UX.

Comment 3 Marek Hulan 2018-05-25 12:05:29 UTC
While I agree the Help is not template specific, it's useful to switch between help tab and template tab since I mostly need to know, what helpers are available, during when I write the template. Stephen, could you describe where exactly you'd like to see the button and whether it should be moved or copied? I guess an input from Roxanne could be helpful too.

Comment 4 Stephen Wadeley 2018-05-25 12:23:46 UTC
(In reply to Marek Hulan from comment #3)
> While I agree the Help is not template specific, it's useful to switch
> between help tab and template tab since I mostly need to know, what helpers
> are available, during when I write the template. 

I never thought of that, on the other hand, if it was a button next to "Create Template" I could right click and open it in a new tab or window.

Stephen, could you describe
> where exactly you'd like to see the button and whether it should be moved or
> copied? I guess an input from Roxanne could be helpful too.

Somewhere near the "Create Template" button.
I do not mind if its move or copied.

Thank you

Comment 5 Lukas Zapletal 2018-05-28 05:37:48 UTC
The goal for this change is to make the help available through docs. Currently we don't have a direct link that could be included in our docs, unless we link help tab of an existing template.

How about extracting this into helper so the contents can be accessed from both places?

Comment 6 Marek Hulan 2018-05-28 06:36:48 UTC
I guess that would work. Still not sure where we'd display that. Perhaps /templates/help (this is now missing the erb template, but route exists)

Comment 7 Lukas Zapletal 2018-05-29 05:51:28 UTC
Stephen, I am going to put this on the backlog for now. This is just UX enhancement. Please instruct to user to visit Help tab in Template edit page for 6.4. Thanks.

Comment 9 Stephen Wadeley 2018-05-29 06:19:54 UTC
(In reply to Lukas Zapletal from comment #7)
> Stephen, I am going to put this on the backlog for now. This is just UX
> enhancement. Please instruct to user to visit Help tab in Template edit page
> for 6.4. Thanks.

OK, will use this bug for that task: Bug 1576234 - Discovery Rules Issues

Once it is copied to the main template window the users will find it themselves.

Thank you

Comment 10 Bryan Kearney 2019-11-04 14:03:20 UTC
Thank you for your interest in Satellite 6. We have evaluated this request, and while we recognize that it is a valid request, we do not expect this to be implemented in the product in the foreseeable future. This is due to other priorities for the product, and not a reflection on the request itself. We are therefore closing this out as WONTFIX. If you have any concerns about this, please do not reopen. Instead, feel free to contact Red Hat Technical Support. Thank you.


Note You need to log in before you can comment on or make changes to this bug.