9 Feb
2017
9 Feb
'17
3:31 p.m.
Hi Marius,
On 9 Feb 2017, at 15:22, Marius Dumitru Florea
<mariusdumitru.florea(a)xwiki.com> 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