Hi all,

For the 5.4.0 we have to go with the assumption that the current
Implementation of the UI, self-explain enough.
With that assumption, we can go ahead and can remove the help links. WDYT?

Making UI self-explain better can be achieved in the 5.5.0 release since
there is a plan to re-write the UI.
For that, I suggest implementing something like UI guide (something similar
to what APIM has done, IMO it is pretty effective) when a user starts a
fresh pack.

Regards,
Thilina.

On Sat, Sep 2, 2017 at 8:14 AM, Shiraz Azad <shi...@wso2.com> wrote:

> +1. for removing links and making the UI self explained.
>
> Shiraz
>
>
> On Thu, Aug 31, 2017 at 7:07 PM, Thilina Madumal <thilina...@wso2.com>
> wrote:
>
>> +1 to remove the links as Johann has suggested.
>>
>> Regards,
>> Thilina.
>>
>> On Thu, Aug 31, 2017 at 11:40 AM, Johann Nallathamby <joh...@wso2.com>
>> wrote:
>>
>>> +1 to remove these links. I think better UX is the solution than asking
>>> users to read more docs.
>>>
>>> Regards,
>>> Johann.
>>>
>>> On Thu, Aug 31, 2017 at 11:04 AM, Samuel Gnaniah <sam...@wso2.com>
>>> wrote:
>>>
>>>> Our strategy here is to remove these help links and walk through the UI
>>>> with the dev team to make the UIs and forms easier to configure without
>>>> requiring additional documentation. This is the stragety we are following
>>>> for all products.
>>>>
>>>> Thanks,
>>>>
>>>> ------
>>>>
>>>> *Samuel Gnaniah*
>>>> Lead Technical Writer
>>>>
>>>> WSO2 (pvt.) Ltd.
>>>> Colombo, Sri Lanka
>>>> (+94) 773131798 <+94%2077%20313%201798>
>>>>
>>>> On Thu, Aug 31, 2017 at 10:51 AM, Sherene Mahanama <sher...@wso2.com>
>>>> wrote:
>>>>
>>>>> +documentation, +shiraz, +samuel
>>>>>
>>>>> On Thu, Aug 31, 2017 at 10:50 AM, Sherene Mahanama <sher...@wso2.com>
>>>>> wrote:
>>>>>
>>>>>> Hi Team,
>>>>>>
>>>>>> We can use [1] as the base URL as it will always point to the latest
>>>>>> docs of IS. If we export an html page though, when we update the doc page
>>>>>> with improvements the changes won't get reflected in the help page right
>>>>>> unless we export again every time we make a change?
>>>>>>
>>>>>> [1] https://docs.wso2.com/identity-server
>>>>>>
>>>>>> Thanks,
>>>>>> Sherene
>>>>>>
>>>>>> On Thu, Aug 31, 2017 at 10:38 AM, Omindu Rathnaweera <omi...@wso2.com
>>>>>> > wrote:
>>>>>>
>>>>>>> One other option would be to export an html from the doc page and
>>>>>>> include it in the product.
>>>>>>>
>>>>>>> On Thu, Aug 31, 2017 at 10:35 AM, Johann Nallathamby <
>>>>>>> joh...@wso2.com> wrote:
>>>>>>>
>>>>>>>> Only problem I see is if Internet access is not available from the
>>>>>>>> client's machine which can access the carbon console, which could be 
>>>>>>>> the
>>>>>>>> case sometimes.
>>>>>>>>
>>>>>>>> On Thu, Aug 31, 2017 at 10:22 AM, Thilina Madumal <
>>>>>>>> thilina...@wso2.com> wrote:
>>>>>>>>
>>>>>>>>> Hi Devs,
>>>>>>>>>
>>>>>>>>> Currently, in IS Management Console, the context sensitive help
>>>>>>>>> pages are outdated. See [1].
>>>>>>>>> Even though the content is up to date, the content is not
>>>>>>>>> informative enough IMO.
>>>>>>>>>
>>>>>>>>> If we are to update the help-pages, we need to make them up to
>>>>>>>>> date and informative enough.
>>>>>>>>> The concern is if we are to do so;
>>>>>>>>>
>>>>>>>>>    1. The effort is significantly high
>>>>>>>>>    2. Also, it is kind of writing another set of documentation
>>>>>>>>>
>>>>>>>>> We already have a nice set of documentation for the Product IS.
>>>>>>>>> Therefore shall we link the already available IS documentation to
>>>>>>>>> Help Pages of IS Management Console? WDYT?
>>>>>>>>>
>>>>>>>>> [1] https://wso2.org/jira/browse/IDENTITY-446
>>>>>>>>>
>>>>>>>>> Thanks & Regards,
>>>>>>>>> Thilina.
>>>>>>>>>
>>>>>>>>> --
>>>>>>>>> *Thilina Madumal*
>>>>>>>>> *Software Engineer | **WSO2*
>>>>>>>>> Email: thilina...@wso2.com
>>>>>>>>> Mobile: *+ <+94%2077%20767%201807>94 774553167*
>>>>>>>>> Web:  <http://goog_716986954>http://wso2.com
>>>>>>>>>
>>>>>>>>> <http://wso2.com/signature>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> --
>>>>>>>> Thanks & Regards,
>>>>>>>>
>>>>>>>> *Johann Dilantha Nallathamby*
>>>>>>>> Senior Lead Solutions Engineer
>>>>>>>> WSO2, Inc.
>>>>>>>> lean.enterprise.middleware
>>>>>>>>
>>>>>>>> Mobile - *+94777776950*
>>>>>>>> Blog - *http://nallaa.wordpress.com <http://nallaa.wordpress.com>*
>>>>>>>>
>>>>>>>> _______________________________________________
>>>>>>>> Dev mailing list
>>>>>>>> Dev@wso2.org
>>>>>>>> http://wso2.org/cgi-bin/mailman/listinfo/dev
>>>>>>>>
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> Omindu Rathnaweera
>>>>>>> Senior Software Engineer, WSO2 Inc.
>>>>>>> Mobile: +94 771 197 211 <+94%2077%20119%207211>
>>>>>>>
>>>>>>> _______________________________________________
>>>>>>> Dev mailing list
>>>>>>> Dev@wso2.org
>>>>>>> http://wso2.org/cgi-bin/mailman/listinfo/dev
>>>>>>>
>>>>>>>
>>>>>>
>>>>>>
>>>>>> --
>>>>>> Sherene Mahanama
>>>>>> Technical Writer
>>>>>>
>>>>>> WSO2 (pvt.) Ltd.
>>>>>> Colombo, Sri Lanka
>>>>>> Mobile: (+94) 777 <%28%2B94%29%20773131798>
>>>>>> *994805*
>>>>>>
>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> Sherene Mahanama
>>>>> Technical Writer
>>>>>
>>>>> WSO2 (pvt.) Ltd.
>>>>> Colombo, Sri Lanka
>>>>> Mobile: (+94) 777 <%28%2B94%29%20773131798>
>>>>> *994805*
>>>>>
>>>>
>>>>
>>>
>>>
>>> --
>>> Thanks & Regards,
>>>
>>> *Johann Dilantha Nallathamby*
>>> Senior Lead Solutions Engineer
>>> WSO2, Inc.
>>> lean.enterprise.middleware
>>>
>>> Mobile - *+94777776950*
>>> Blog - *http://nallaa.wordpress.com <http://nallaa.wordpress.com>*
>>>
>>> --
>>> You received this message because you are subscribed to the Google
>>> Groups "WSO2 Documentation Group" group.
>>> To unsubscribe from this group and stop receiving emails from it, send
>>> an email to documentation+unsubscr...@wso2.com.
>>> For more options, visit https://groups.google.com/a/wso2.com/d/optout.
>>>
>>
>>
>>
>> --
>> *Thilina Madumal*
>> *Software Engineer | **WSO2*
>> Email: thilina...@wso2.com
>> Mobile: *+ <+94%2077%20767%201807>94 774553167*
>> Web:  <http://goog_716986954>http://wso2.com
>>
>> <http://wso2.com/signature>
>>
>>
>
>
> --
> Shiraz Azad
> Technical Writer
> WSO2 Inc.
>
> Mobile: 0094777062384
>



-- 
*Thilina Madumal*
*Software Engineer | **WSO2*
Email: thilina...@wso2.com
Mobile: *+ <+94%2077%20767%201807>94 774553167*
Web:  <http://goog_716986954>http://wso2.com

<http://wso2.com/signature>
_______________________________________________
Dev mailing list
Dev@wso2.org
http://wso2.org/cgi-bin/mailman/listinfo/dev

Reply via email to