Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

On Tue, Sep 12, 2017 at 5:01 PM, Johann Nallathamby 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

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

Hi Samuel, > > On Tue, Sep 12, 2017 at 9:38 AM, Samuel Gnaniah 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

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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 my opinion. Regards, Johann. On Tue, Sep 12, 2017 at 4:43 PM,

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

Hi Samuel, On Tue, Sep 12, 2017 at 9:38 AM, Samuel Gnaniah 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

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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. -- *Samuel Gnaniah* Lead Technical Writer WSO2

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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,

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

+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 wrote: > Agree with Thilina. At the same time, we should make

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

+1 to remove the links as Johann has suggested. Regards, Thilina. On Thu, Aug 31, 2017 at 11:40 AM, Johann Nallathamby 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

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

+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 wrote: > Our strategy here is to remove these help links and walk through the UI > with the dev team to make the

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

+documentation, +shiraz, +samuel On Thu, Aug 31, 2017 at 10:50 AM, Sherene Mahanama 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

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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]

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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 wrote: > Only problem I see is if Internet access is not available from the > client's machine which can access the carbon console,

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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 wrote: > Hi Devs, > > Currently, in IS Management Console, the

Re: [Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

On Thu, Aug 31, 2017 at 10:22 AM, Thilina Madumal 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

[Dev] [IS] Shall We Link Corresponding IS Documentation as Context Sensitive Help Pages in IS Management Console?

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