Stetson Robinson <sterobin@redhat.com>
Some confusion about "unsupported" vs. "disabled" features in the UI
14 messages
Stetson Robinson <sterobin@redhat.com>Mon, Oct 9, 2017 at 9:59 AM
To: Jozef Marko <jomarko@redhat.com>, Michael Anstis <manstis@redhat.com>
Cc: Vidya Iyengar <viyengar@redhat.com>, Ivo Bek <ibek@redhat.com>
Hey Jozef and Michael:

In BPMSPL-756, several features are mentioned as excluded from the UI. An email from Michael to me confirmed that they are essentially these:

1) Guided Decision Trees
2) Guided Score Cards
3) XLS Score Cards
4) "New" jBPM Designer (IDK what other names it might go by)
5) Provisioning Perspective (again IDK what else this may be known as)

But there seems to be some confusion about "unsupported" vs. "disabled" features in the UI. Unsupported features should not be in our Red Hat docs. Disabled features, however, should be documented if they can reasonably be enabled, but we need to know why they are disabled and how to enable them. BPMSPL-756 touches on that, but it's a bit confusing.

Example: Deployments

Jozef has created BXMSDOC-1828, which says that Process Deployments needs to be changed to Deployments (among other things mentioned). But this is disabled and needs to be enabled somehow to appear.

But Michael has mentioned in one of my PRs that "due to BPMSPL-756, Deployments on the Home Page will not be shown by default as it is an unsupported feature."

So are Deployments unsupported or disabled? 

My general questions:
- What features are "unsupported" and thus not documentable, and which features are supported but are just "disabled"?
- Can someone clearly explain how to enable a disabled feature? And why they are disabled to begin with?

Thanks,

--

STETSON ROBINSON

TECHNICAL WRITER, MIDDLEWARE

Red Hat

100 East Davie St

Raleigh, NC 27601

sterobin@redhat.com    M: 801.703.8294    

Jozef Marko <jomarko@redhat.com>Mon, Oct 9, 2017 at 10:07 AM
To: Stetson Robinson <sterobin@redhat.com>
Cc: Michael Anstis <manstis@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Ivo Bek <ibek@redhat.com>
Hi, sorry if I caused some misunderstanding.

In the context of BPMSPL-756 I think assets are unsupported, perspectives, there is only one - Deployments, is disabled. Correct me someone please if I am wrong.
[Quoted text hidden]
--
Regards, Jozef
BPMS Quality Engineer
Michael Anstis <manstis@redhat.com>Mon, Oct 9, 2017 at 10:34 AM
To: Jozef Marko <jomarko@redhat.com>
Cc: Stetson Robinson <sterobin@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Ivo Bek <ibek@redhat.com>
"Deployments" (as currently mentioned in the UI) is for "Server Provisioning" (i.e. build a WAR, deploy it to a server/cloud).

"Process Deployments" probably refers to (deployment of KJARs) to KIE Server. This is probably where the confusion arises: overloading the term "deployments".

I guess if (deployment of KJARs) to KIE Server is to be called "Deployments" we'll need a new name for the disabled/unsupported feature "Server provisioning" (that is also currently called "Deployments")!

The list I provided was "unsupported features" BUT the request included the ability to allow Users/Customers to re-enable them and understand the risk of using unsupported features.

Ivo may have an opinion how he wants unsupported and disabled features to be documented.. as the User could enable them if they wish.

With kind regards,

Mike



[Quoted text hidden]
Stetson Robinson <sterobin@redhat.com>Tue, Oct 10, 2017 at 4:08 PM
To: Michael Anstis <manstis@redhat.com>
Cc: Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Ivo Bek <ibek@redhat.com>
Ivo, any thoughts on this? Michael is punting to you for input. The question on the table is how we want to handle/document unsupported vs. disabled features. For example, BXMSDOC-1828.
[Quoted text hidden]
Ivo Bek <ibek@redhat.com>Wed, Oct 11, 2017 at 7:06 AM
To: Stetson Robinson <sterobin@redhat.com>
Cc: Michael Anstis <manstis@redhat.com>, Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>
Hi,

from the technical point of view I expect that we won't distinguish between supported and unsupported components when we talk about enabling / disabling them.

enabledComponents = [oldProcessDesigner, ...]
disabledComponents = [newProcessDesigner, ServerProvisioning, ...]

The way how an administrator can enable or disable some components or features needs to be documented. It's the customer's choice to enable any of the features which are in the product (in some situations CEE helps even with the unsupported features because customers need them for some reason and if it is in the CEE's power they want to make the customer happy).

When we walk about documenting each component / feature. Only the supported components should be fully documented but I would encourage to make some draft documentation for the new disabled components as well (new Process Designer, Server Provisioning, etc.) because people will be looking for some help with the new, experimental components and the time will come when we make the disabled components enabled by default.

Which brings us to unsupported components... of course we don't want to document them, that's understandable but there should be the list of bigger, significant components which are stated as unsupported. The best would be to have such list in the place where administrators enable / disable components so that they can be warned about enabling unsupported component ... and that list could be updated before every GA release.

/**
List of unsupported components:
 - ScoreCards
 - Decision Trees
 ...
*/

What do you think?

Regards,
Ivo
[Quoted text hidden]
Stetson Robinson <sterobin@redhat.com>Wed, Oct 11, 2017 at 8:26 AM
To: Ivo Bek <ibek@redhat.com>
Cc: Michael Anstis <manstis@redhat.com>, Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Christy Watkins <cwatkins@redhat.com>
+ Christy Watkins

Thanks Ivo. I think it makes sense to have a section that lists unsupported features and a section or sections on how to enable them.

So let's get more specific. 

1.) List of unsupported features: What exactly are the current features that are not supported that we want documented for 7.0 GA?

Here's the list we have so far from BPMSPL-756, as summarized by Michael Anstis:

1) Guided Decision Trees
2) Guided Score Cards
3) XLS Score Cards
4) "New" jBPM Designer (IDK what other names it might go by)
5) Provisioning Perspective (again IDK what else this may be known as)

Are there other unsupported features that you think merit mention in 7.0 GA?

2.) Enabling unsupported features: How exactly do users enable these unsupported (and thus disabled) features? And is the process generic for any feature or does the process depend on which feature it is? We need to know exactly how to do this so we can document it fully.

3.) What to do about "Process Deployments"/"Deployments" in UI for 7.0 LA: Can you please clarify what we're supposed to be doing with Process Deployments in the UI, as explained in BXMSDOC-1828? Jozef explains that we need to change Process Deployments to Deployments in 7.0 LA per the new UI (understood), but he noted in this thread that he believes Deployments are also disabled/unsupported by default, and need to be enabled by the user. He asked for someone to confirm. So are Deployments in fact unsupported and need to be enabled by the user? If so, again, how do users enable it, or any unsupported feature? From Jozef's explanation, maybe BXMSDOC-1337 is how it is enabled, but I'm not clear on this.

Thanks Ivo.
[Quoted text hidden]
Ivo Bek <ibek@redhat.com>Fri, Oct 13, 2017 at 5:14 AM
To: Stetson Robinson <sterobin@redhat.com>
Cc: Michael Anstis <manstis@redhat.com>, Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Christy Watkins <cwatkins@redhat.com>
Hi Stetson,

1) there are other unsupported features such as Embedding perspectives - I think that the only one we agreed to support is AuthoringPerspective with some configurations ... but I don't remember all of the unsupported features, so it might be good to check it with QE (Lukas Petrovicky) and CEE (Martin Weiler) what they would like to mention in the list.

2) Ask Michael Anstis if he is the one implementing https://issues.jboss.org/browse/BPMSPL-756 ... the process of disabling or enabling a feature should be generic in a single place.

3) Sorry, I don't know what this one is...

Regards,
Ivo


[Quoted text hidden]
Michael Anstis <manstis@redhat.com>Fri, Oct 13, 2017 at 6:15 AM
To: Ivo Bek <ibek@redhat.com>
Cc: Stetson Robinson <sterobin@redhat.com>, Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Christy Watkins <cwatkins@redhat.com>
> 2) Ask Michael Anstis if he is the one implementing https://issues.jboss.org/browse/BPMSPL-756 ...

It has been implemented. Enabling/disabling is performed in the User's Security management settings. See https://issues.jboss.org/secure/attachment/12426185/BPMSPL-756-permissions.png


[Quoted text hidden]
Stetson Robinson <sterobin@redhat.com>Fri, Oct 13, 2017 at 8:18 AM
To: Michael Anstis <manstis@redhat.com>
Cc: Ivo Bek <ibek@redhat.com>, Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Christy Watkins <cwatkins@redhat.com>
Thanks Ivo and Michael.

I understand now that users go to gear icon > Roles, select the role, and enable/disable Menu items/perspectives  as needed, but we still need to know what users can count on being there upon setup and what they need to physically enable, so we can document that, which is what I've been trying to get at throughout this thread.

So Michael, the golden question: Can you or someone else tell me which Menu options are enabled by default when a user opens the product for the first time? If we can just know which are default items, then we can know which ones to tell users they need to enable. 

Thanks,
[Quoted text hidden]
Michael Anstis <manstis@redhat.com>Fri, Oct 13, 2017 at 8:21 AM
To: Stetson Robinson <sterobin@redhat.com>
Cc: Ivo Bek <ibek@redhat.com>, Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Christy Watkins <cwatkins@redhat.com>
Hi Stetson.. great distances can be covered with the smallest of steps :-)

For BRMS look at the Home Page attachments here: https://issues.jboss.org/browse/BPMSPL-756 (one is the default; the other is with items enabled).

I'll do something similar for BPMS in a few minutes and attach them to the JIRA.. if it gives you what you need?

Cheers,

Mike
[Quoted text hidden]
Stetson Robinson <sterobin@redhat.com>Fri, Oct 13, 2017 at 8:30 AM
To: Michael Anstis <manstis@redhat.com>
Cc: Ivo Bek <ibek@redhat.com>, Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Christy Watkins <cwatkins@redhat.com>, brms-docs <brms-docs@redhat.com>
+ Emily Murphy (who'll be updating settings, RN, etc.) and brms-docs

YES!!! Yaaay! That's what we needed to know. Yes, please do the same for BPM and we'll be set. Thank you so much Michael!

So all, in summary:

1) Unsupported/disabled options: We'll now consider documenting any and all Menu items not listed by default, as will be show in Michael's screenshots for BRMS and BPM in BPMSPL-756, which can be enabled in settings > Roles > select role.
2) Enabling settings: Settings icon > Roles > select role > enable/disable as needed.
3) Process Deployments: Changed to just "Deployments", and is disabled by default. Enabled as described in item 2.

Thanks so much all!
[Quoted text hidden]
Michael Anstis <manstis@redhat.com>Fri, Oct 13, 2017 at 9:12 AM
To: Stetson Robinson <sterobin@redhat.com>
Cc: Ivo Bek <ibek@redhat.com>, Jozef Marko <jomarko@redhat.com>, Vidya Iyengar <viyengar@redhat.com>, Christy Watkins <cwatkins@redhat.com>, brms-docs <brms-docs@redhat.com>
Images attached to JIRA.

(Remember however that "Process deloyments" is likely to change to "Deployments" and the current "Deployments" needs a new name).
[Quoted text hidden]
Michele Haglund <mhaglund@redhat.com>Fri, Oct 13, 2017 at 11:10 AM
To: Stetson Robinson <sterobin@redhat.com>
Cc: Michael Anstis <manstis@redhat.com>, Ivo Bek <ibek@redhat.com>, Jozef Marko <jomarko@redhat.com>, brms-docs <brms-docs@redhat.com>
Hello all. So, I had updated the GSG for LA using the "new" disabled functionality. I worked closed with Marek and Ivo to rework that guide. I have a couple of questions.

1. Should we create a reusable module to add to the various guides describing how to turn on and off the various options?
2. This one is for the writers and Ivo. Should we use the GSG as an "example" of using this new functionality? I would add a note at the top of that guide stating that the process in the GSG was done using the "tech preview" functionality and then provide a link to how we disable and enable the options. Does everyone agree with this approach?

Frankly, I was struggling with updating chapter 6 (Process Designer) in the User Guide because of the fact that I wasn't aware of the options. I am relieved that I was able to toggle the options using the latest build to see both versions. This also leads me to think that the updates to that large chapter will not be as time-consuming. 

Please let me know your thoughts on my questions. 

Thank you,






Michele Haglund
Technical Writer, Middleware Product Documentation
Red Hat, Inc.


[Quoted text hidden]
Michele Haglund <mhaglund@redhat.com>Fri, Oct 13, 2017 at 1:37 PM
To: brms-docs <brms-docs@redhat.com>
I should have added that if we agree to create a reusable module as mentioned in my previous note. I'm happy to take that on. 
I'm on PTO, but will be back full time starting on Tuesday.


Michele Haglund
Technical Writer, Middleware Product Documentation
Red Hat, Inc.



[Quoted text hidden]
Save