Help Center

classic Classic list List threaded Threaded
7 messages Options
Reply | Threaded
Open this post in threaded view
|

Help Center

Marius Dumitru Florea
Hi all,

For the 9.1 roadmap, see
http://www.xwiki.org/xwiki/bin/view/Roadmaps/#HXWiki9.0-9-2, Caty and I
have worked on a Help Center to cover the "Demo Content" and (partially)
the "In-Product Tours and Documentation" topics. I opened this issue
http://jira.xwiki.org/browse/XWIKI-14018 to follow the progress. I
committed a first working version on
https://github.com/xwiki/xwiki-platform/tree/feature-help-center .

I committed the code in platform mainly because we already have a
xwiki-platform-help-ui module which is related, but we can discuss putting
the help center in a different place:
* either a separate child module of xwiki-platform-help (to separate the
help center from the rest of the help pages like the XWiki syntax help and
the tips panel)
* on xwiki-contrib

Caty named it "Help Center" in the initial proposal, then used "Help" in
the prototype. We need to decide which one is best. I'm fine with both. The
version I committed uses "Help Center".

The help center pages have quite a few images and 4 big gifs (animated
steps) which leads to a 22Mb XAR. I hope the size won't cause any issue. It
may slow down the XWiki Enterprise functional tests setup?

Caty and I would like to put the help center pages on playground.xwiki.org
so that we can measure if it's useful (without having to wait for the
playground wiki to be upgraded to XWiki 9.1).

WDYT?

Thanks,
Marius
Reply | Threaded
Open this post in threaded view
|

Re: Help Center

vmassol
Administrator
Hi Marius,

> On 9 Feb 2017, at 15:22, Marius Dumitru Florea <[hidden email]> wrote:
>
> Hi all,
>
> For the 9.1 roadmap, see
> http://www.xwiki.org/xwiki/bin/view/Roadmaps/#HXWiki9.0-9-2, Caty and I
> have worked on a Help Center to cover the "Demo Content" and (partially)
> the "In-Product Tours and Documentation" topics. I opened this issue
> http://jira.xwiki.org/browse/XWIKI-14018 to follow the progress. I
> committed a first working version on
> https://github.com/xwiki/xwiki-platform/tree/feature-help-center .

Thanks. I’ve also raised a few questions on http://jira.xwiki.org/browse/XWIKI-14018

> I committed the code in platform mainly because we already have a
> xwiki-platform-help-ui module which is related, but we can discuss putting
> the help center in a different place:
> * either a separate child module of xwiki-platform-help (to separate the
> help center from the rest of the help pages like the XWiki syntax help and
> the tips panel)
> * on xwiki-contrib

I think it would make more sense on xwiki-contrib since we’d want to possibly release it more often than the core (add new content or fix/modify existing content) and I don’t consider it core.

> Caty named it "Help Center" in the initial proposal, then used "Help" in
> the prototype. We need to decide which one is best. I'm fine with both. The
> version I committed uses "Help Center”.

Help Center is fine with me. I’m also fine with both.

> The help center pages have quite a few images and 4 big gifs (animated
> steps) which leads to a 22Mb XAR. I hope the size won't cause any issue. It
> may slow down the XWiki Enterprise functional tests setup?

1) What are those 4 gifs doing? Do they require maintenance? Can we reduce their size?
2) For XE functional tests that’s ok since we would bundle the Help Center app by default so only the functional tests for the help center itself would incur the extra size (but I don’t see it as a big issue).

> Caty and I would like to put the help center pages on playground.xwiki.org
> so that we can measure if it's useful (without having to wait for the
> playground wiki to be upgraded to XWiki 9.1).
>
> WDYT?

+1

Thanks
-Vincent

> Thanks,
> Marius

Reply | Threaded
Open this post in threaded view
|

Re: Help Center

Marius Dumitru Florea
On Thu, Feb 9, 2017 at 4:31 PM, Vincent Massol <[hidden email]> wrote:

> Hi Marius,
>
> > On 9 Feb 2017, at 15:22, Marius Dumitru Florea <
> [hidden email]> wrote:
> >
> > Hi all,
> >
> > For the 9.1 roadmap, see
> > http://www.xwiki.org/xwiki/bin/view/Roadmaps/#HXWiki9.0-9-2, Caty and I
> > have worked on a Help Center to cover the "Demo Content" and (partially)
> > the "In-Product Tours and Documentation" topics. I opened this issue
> > http://jira.xwiki.org/browse/XWIKI-14018 to follow the progress. I
> > committed a first working version on
> > https://github.com/xwiki/xwiki-platform/tree/feature-help-center .
>
> Thanks. I’ve also raised a few questions on http://jira.xwiki.org/browse/
> XWIKI-14018
>
> > I committed the code in platform mainly because we already have a
> > xwiki-platform-help-ui module which is related, but we can discuss
> putting
> > the help center in a different place:
> > * either a separate child module of xwiki-platform-help (to separate the
> > help center from the rest of the help pages like the XWiki syntax help
> and
> > the tips panel)
> > * on xwiki-contrib
>
> I think it would make more sense on xwiki-contrib since we’d want to
> possibly release it more often than the core (add new content or fix/modify
> existing content) and I don’t consider it core.
>

It would also allow us to install and upgrade the help center on playground
template more easily (through the EM) instead of using XAR import. The only
(minor) issue is that the help center shares the "Help" space and more
importantly the Help.WebHome page with the xwiki-platform-help-ui module.


>
> > Caty named it "Help Center" in the initial proposal, then used "Help" in
> > the prototype. We need to decide which one is best. I'm fine with both.
> The
> > version I committed uses "Help Center”.
>
> Help Center is fine with me. I’m also fine with both.
>
> > The help center pages have quite a few images and 4 big gifs (animated
> > steps) which leads to a 22Mb XAR. I hope the size won't cause any issue.
> It
> > may slow down the XWiki Enterprise functional tests setup?
>
> 1) What are those 4 gifs doing? Do they require maintenance? Can we reduce
> their size?
>

Caty used a tool (I don't remember the name) to record the steps needed to
perform some action (e.g. insert and edit a wiki macro through the WYSIWYG)
as a GIF. Similar to what Guillaume did for
http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/8.4.2/#HLocalizationSection
. Now, I see that Guillaume's GIF is 400kb (compared to Caty's 2-3Mb) so
maybe there's a way to generate smaller GIFs, but it may require reducing
the quality. In any case, I think they are useful, but they do require
maintenance..


> 2) For XE functional tests that’s ok since we would bundle the Help Center
> app by default so only the functional tests for the help center itself
> would incur the extra size (but I don’t see it as a big issue).
>
> > Caty and I would like to put the help center pages on
> playground.xwiki.org
> > so that we can measure if it's useful (without having to wait for the
> > playground wiki to be upgraded to XWiki 9.1).
> >
> > WDYT?
>
> +1
>
> Thanks
> -Vincent
>
> > Thanks,
> > Marius
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Help Center

Sergiu Dumitriu-3
On 02/09/2017 09:54 AM, Marius Dumitru Florea wrote:

> On Thu, Feb 9, 2017 at 4:31 PM, Vincent Massol <[hidden email]> wrote:
>
>> 1) What are those 4 gifs doing? Do they require maintenance? Can we reduce
>> their size?
>>
>
> Caty used a tool (I don't remember the name) to record the steps needed to
> perform some action (e.g. insert and edit a wiki macro through the WYSIWYG)
> as a GIF. Similar to what Guillaume did for
> http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/8.4.2/#HLocalizationSection
> . Now, I see that Guillaume's GIF is 400kb (compared to Caty's 2-3Mb) so
> maybe there's a way to generate smaller GIFs, but it may require reducing
> the quality. In any case, I think they are useful, but they do require
> maintenance..
>

gifsicle does lossless GIF optimization, give it a try.

--
Sergiu Dumitriu
http://purl.org/net/sergiu
Reply | Threaded
Open this post in threaded view
|

Re: Help Center

Ecaterina Moraru (Valica)
In reply to this post by Marius Dumitru Florea
On Thu, Feb 9, 2017 at 3:22 PM, Marius Dumitru Florea <
[hidden email]> wrote:

> Hi all,
>
> For the 9.1 roadmap, see
> http://www.xwiki.org/xwiki/bin/view/Roadmaps/#HXWiki9.0-9-2, Caty and I
> have worked on a Help Center to cover the "Demo Content" and (partially)
> the "In-Product Tours and Documentation" topics. I opened this issue
> http://jira.xwiki.org/browse/XWIKI-14018 to follow the progress. I
> committed a first working version on
> https://github.com/xwiki/xwiki-platform/tree/feature-help-center .
>
> I committed the code in platform mainly because we already have a
> xwiki-platform-help-ui module which is related, but we can discuss putting
> the help center in a different place:
> * either a separate child module of xwiki-platform-help (to separate the
> help center from the rest of the help pages like the XWiki syntax help and
> the tips panel)
> * on xwiki-contrib
>
> Caty named it "Help Center" in the initial proposal, then used "Help" in
> the prototype. We need to decide which one is best. I'm fine with both. The
> version I committed uses "Help Center".
>

I've used 'Help' in order to be smaller on the breadcrumb, more
recognizable and generic, and to have a single word in the AppBar, menus.


>
> The help center pages have quite a few images and 4 big gifs (animated
> steps) which leads to a 22Mb XAR. I hope the size won't cause any issue. It
> may slow down the XWiki Enterprise functional tests setup?
>
> Caty and I would like to put the help center pages on playground.xwiki.org
> so that we can measure if it's useful (without having to wait for the
> playground wiki to be upgraded to XWiki 9.1).
>
> WDYT?
>

Thanks Sergiu for the GIF suggestion.

Caty


>
> Thanks,
> Marius
>
Reply | Threaded
Open this post in threaded view
|

Re: Help Center

Marius Dumitru Florea
In reply to this post by Sergiu Dumitriu-3
On Thu, Feb 9, 2017 at 4:58 PM, Sergiu Dumitriu <[hidden email]> wrote:

> On 02/09/2017 09:54 AM, Marius Dumitru Florea wrote:
> > On Thu, Feb 9, 2017 at 4:31 PM, Vincent Massol <[hidden email]>
> wrote:
> >
> >> 1) What are those 4 gifs doing? Do they require maintenance? Can we
> reduce
> >> their size?
> >>
> >
> > Caty used a tool (I don't remember the name) to record the steps needed
> to
> > perform some action (e.g. insert and edit a wiki macro through the
> WYSIWYG)
> > as a GIF. Similar to what Guillaume did for
> > http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/8.4.2/#
> HLocalizationSection
> > . Now, I see that Guillaume's GIF is 400kb (compared to Caty's 2-3Mb) so
> > maybe there's a way to generate smaller GIFs, but it may require reducing
> > the quality. In any case, I think they are useful, but they do require
> > maintenance..
> >
>
>

> gifsicle does lossless GIF optimization, give it a try.
>

It doesn't very help much. We have 6 GIFs between 1.7 and 5 MB, and 15.73
MB in total. After executing

gifsicle -O3 --no-extensions

the total size is reduced only by 0.16 MB, so we're still left with 15 MB
of GIFs.

I'll try to optimize the images also, which take the rest of 7 MB.

Thanks,
Marius


>
> --
> Sergiu Dumitriu
> http://purl.org/net/sergiu
>
Reply | Threaded
Open this post in threaded view
|

Re: Help Center

Marius Dumitru Florea
On Mon, Feb 13, 2017 at 4:17 PM, Marius Dumitru Florea <
[hidden email]> wrote:

> On Thu, Feb 9, 2017 at 4:58 PM, Sergiu Dumitriu <[hidden email]> wrote:
>
>> On 02/09/2017 09:54 AM, Marius Dumitru Florea wrote:
>> > On Thu, Feb 9, 2017 at 4:31 PM, Vincent Massol <[hidden email]>
>> wrote:
>> >
>> >> 1) What are those 4 gifs doing? Do they require maintenance? Can we
>> reduce
>> >> their size?
>> >>
>> >
>> > Caty used a tool (I don't remember the name) to record the steps needed
>> to
>> > perform some action (e.g. insert and edit a wiki macro through the
>> WYSIWYG)
>> > as a GIF. Similar to what Guillaume did for
>> > http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/
>> 8.4.2/#HLocalizationSection
>> > . Now, I see that Guillaume's GIF is 400kb (compared to Caty's 2-3Mb) so
>> > maybe there's a way to generate smaller GIFs, but it may require
>> reducing
>> > the quality. In any case, I think they are useful, but they do require
>> > maintenance..
>> >
>>
>>
>
>> gifsicle does lossless GIF optimization, give it a try.
>>
>
> It doesn't very help much. We have 6 GIFs between 1.7 and 5 MB, and 15.73
> MB in total. After executing
>
> gifsicle -O3 --no-extensions
>
> the total size is reduced only by 0.16 MB, so we're still left with 15 MB
> of GIFs.
>
>

> I'll try to optimize the images also, which take the rest of 7 MB.
>

With optimized GIFs and PNGs the size of the XAR is now 18.8 MB.


>
> Thanks,
> Marius
>
>
>>
>> --
>> Sergiu Dumitriu
>> http://purl.org/net/sergiu
>>
>
>