On Tue, Sep 12, 2017 at 5:01 PM, Johann Nallathamby <[email protected]> wrote:
> IMO Help link are good for a public facing application. E.g. API Store, > Google Apps, etc. I don't think for a administrator application help link > is necessary. Administrator applications are generally accompanied with a > manual. > Just to be clear, what I meant is other large software ship with large physical manuals or pdfs. So linking documentation from website is not something I see commonly. And also it's going to be very difficult to find and link specific sections. If linking documentation is going to be worse experience than what is there now we shouldn't do it. Having help pages was a good idea in the begining. But we haven't updated it for a long time. So although updating the help links will be ideal, given the time we have in our hand removing the links would be the optimal solution if we want to fix this IMHO. > > Just my opinion. > > Regards, > Johann. > > On Tue, Sep 12, 2017 at 4:43 PM, Thilina Madumal <[email protected]> > wrote: > >> Hi Samuel, >> >> On Tue, Sep 12, 2017 at 9:38 AM, Samuel Gnaniah <[email protected]> wrote: >> >>> If the user needs to refer to the documentation to fill a form in the >>> UI, that means the UI is not intuitive enough for the user. Better UX is a >>> better and more sustainable solution, even if it means a wider set of >>> changes in the short term. >>> >> >> I sugessted this idea in an earlier reply to this thread. But as we >> consider the practical perspective I would like to make some changes to >> that idea. >> >> 1. I don't stand with removing the help links completely. I would >> rather (as minoli have sugested) go with linking IS documentation with >> those links. >> 2. Making UI intuitive is a good option but it is a progressive >> effort. On the other hand even though we achieved it we can't let go of >> help documentation because it is not feasible to achieve that level of UI >> intuitivity. >> >> >>> ------ >>> >>> *Samuel Gnaniah* >>> Lead Technical Writer >>> >>> WSO2 (pvt.) Ltd. >>> Colombo, Sri Lanka >>> (+94) 773131798 <+94%2077%20313%201798> >>> >>> On Tue, Sep 12, 2017 at 9:31 AM, Minoli Perera <[email protected]> wrote: >>> >>>> IMO we should link the specific documentation pages related to the page >>>> topics without completely removing help link, then if the user needs help >>>> s/he need not search for the related content. Even though It is not >>>> accessible without internet for most of the cases it will be helpful. >>>> >>>> Thanks, >>>> Minoli >>>> >>>> On Tue, Sep 5, 2017 at 2:26 PM, Darshana Gunawardana <[email protected] >>>> > wrote: >>>> >>>>> +1 to remove this. >>>>> >>>>> This is something comes from kernel right? So this is something has to >>>>> agree with all products. >>>>> >>>>> Are we ok to remove this in a kernel patch release? >>>>> >>>>> On Tue, Sep 5, 2017 at 1:58 PM, Shiraz Azad <[email protected]> wrote: >>>>> >>>>>> Agree with Thilina. At the same time, we should make sure we dont >>>>>> clutter the UI with explaining notes. In that case, a UI guide will be >>>>>> really effective. +1 for that. >>>>>> >>>>>> Thanks >>>>>> Shiraz >>>>>> >>>>>> On Mon, Sep 4, 2017 at 10:41 AM, Thilina Madumal <[email protected] >>>>>> > wrote: >>>>>> >>>>>>> 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 <[email protected]> wrote: >>>>>>> >>>>>>>> +1. for removing links and making the UI self explained. >>>>>>>> >>>>>>>> Shiraz >>>>>>>> >>>>>>>> >>>>>>>> On Thu, Aug 31, 2017 at 7:07 PM, Thilina Madumal < >>>>>>>> [email protected]> wrote: >>>>>>>> >>>>>>>>> +1 to remove the links as Johann has suggested. >>>>>>>>> >>>>>>>>> Regards, >>>>>>>>> Thilina. >>>>>>>>> >>>>>>>>> On Thu, Aug 31, 2017 at 11:40 AM, Johann Nallathamby < >>>>>>>>> [email protected]> 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 <[email protected] >>>>>>>>>> > 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 < >>>>>>>>>>> [email protected]> wrote: >>>>>>>>>>> >>>>>>>>>>>> +documentation, +shiraz, +samuel >>>>>>>>>>>> >>>>>>>>>>>> On Thu, Aug 31, 2017 at 10:50 AM, Sherene Mahanama < >>>>>>>>>>>> [email protected]> 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 < >>>>>>>>>>>>> [email protected]> 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 < >>>>>>>>>>>>>> [email protected]> 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 < >>>>>>>>>>>>>>> [email protected]> 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: [email protected] >>>>>>>>>>>>>>>> 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 >>>>>>>>>>>>>>> [email protected] >>>>>>>>>>>>>>> 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 >>>>>>>>>>>>>> [email protected] >>>>>>>>>>>>>> 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 [email protected]. >>>>>>>>>> For more options, visit https://groups.google.com/a/ws >>>>>>>>>> o2.com/d/optout. >>>>>>>>>> >>>>>>>>> >>>>>>>>> >>>>>>>>> >>>>>>>>> -- >>>>>>>>> *Thilina Madumal* >>>>>>>>> *Software Engineer | **WSO2* >>>>>>>>> Email: [email protected] >>>>>>>>> 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: [email protected] >>>>>>> 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 >>>>>> >>>>>> -- >>>>>> 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 [email protected]. >>>>>> For more options, visit https://groups.google.com/a/wso2.com/d/optout >>>>>> . >>>>>> >>>>> >>>>> >>>>> >>>>> -- >>>>> Regards, >>>>> >>>>> >>>>> *Darshana Gunawardana*Technical Lead >>>>> WSO2 Inc.; http://wso2.com >>>>> >>>>> *E-mail: [email protected] <[email protected]>* >>>>> *Mobile: +94718566859 <+94%2071%20856%206859>*Lean . Enterprise . >>>>> Middleware >>>>> >>>>> -- >>>>> 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 [email protected]. >>>>> For more options, visit https://groups.google.com/a/wso2.com/d/optout. >>>>> >>>> >>>> >>>> >>>> -- >>>> Minoli Perera, >>>> Software Engineer, WSO2, Inc. >>>> E-mail : [email protected] >>>> Mobile : +94771567527 <+94%2077%20156%207527> >>>> <http://wso2.com/signature> >>>> >>> >>> >> Regards, >> Thilina. >> >> -- >> *Thilina Madumal* >> *Software Engineer | **WSO2* >> Email: [email protected] >> 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>* > -- 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 [email protected] http://wso2.org/cgi-bin/mailman/listinfo/dev
