23 Aug
2017
23 Aug
'17
2:23 p.m.
On Tue, Aug 22, 2017 at 10:39 PM, Clément Aubin <clement.aubin(a)xwiki.com>
wrote:
Thank you,
Caty
Hi,
Replying a bit late, but here are my thoughts,
On 08/21/2017 06:15 PM, Ecaterina Moraru (Valica) wrote:
Some might disagree with that :)
We should also:
- Move User guide from Enterprise wiki. Also deprecate the wiki.
- It's confusing that the documentation is spread in main wiki,
Enterprise
and Platform wikis. Maybe we can merge Platform
with main wiki?
+1 for the two propositions, IMHO we should have a really good idea on
how to organize xwiki.org before moving the doc. That means having clear
categories, and clear subcategories (which is, from my point of view,
not really the case actually).
One example :
- Documentation : how to work with XWiki ?
- For users
- For administrators
- For extension developers
- Maybe some elements from contrib.xwiki.org
- For core developers
- Coding style
- Development process
- References
- Script Services
- UIXP
- …
- Project : the state / the evolution of the project
- Releases
- Release notes
- Release plans
- Health
- GitHub stats
- Active installs
- Blog
yes, there are some overlapping like pages from Platform with pages from
Dev; pages from platform/xe with pages from exo; pages from main wiki with
pages from all over; but it's kind of hard to decide since both places make
a bit of sense.
Also this kind of reorganization takes a bit of work.
What is important is to plan for the flavors. If we consider them as
extensions, than the documentation goes to exo. XE will be deprecated.
Platform and main wiki can be merged.
I don't have a clear answer.
IMHO, having multiple subwikis is not that big of a deal if we don’t
include too much links hopping from one wiki to another. Also, the wiki
name should be relevant to a standard user.
For example, I’m not sure that a standard user understands what
platform.xwiki.org is made for.
Anyway, we might have to develop this in another thread …
There is some work done in a related direction on the Multi Page Tours.
- Not sure why Release Notes and Roadmap are on
main wiki and not on
Devs.
Thanks,
Caty
[...]
>>> On 18 Aug 2017, at 15:48, Ecaterina
Moraru (Valica) <
valicac(a)gmail.com>
>> wrote:
>>>
>>> The displayed videos are from Dec 2015, done on XWiki 7.4 (by Silvia)
>> and
>>> Mar 2016, on XWiki 7.4.1 (by Andrea Russo).
>>
>> The fact that lots of them use the GWT WYSIWYG editor make them
obsolete
>> already.
We could create a special "functional tour" that is based on what we
currently do with functional tests but that associates an audio file to
each step of the platform walkthrough. OFC we would have to record audio
files and it could be a pain (and time consuming), but at least it’s
fun, and we can re-use parts of this functional tour after an upgrade.
>> Thanks
>> -Vincent
>>
The documentation design looks really really nice !
Thanks !
Clément