XWiki.org Documentation Reorganization (batch 2)

[vmassol]

@MichaelHamann

Navigation between different parts of the documentation is weird, I’m totally disoriented by the fact that I cannot systematically read through all its documentation without using the breadcrumb navigation, which seems weird to use as it requires two clicks and the tree isn’t permanently visible. Further, there seems to be no intended reading order which makes it difficult to follow if you’re not already familiar with the feature. Sure, I could go back to the main page or use the “related” links at the bottom to go to the different pages, but this is cumbersome and gives me no clue where I am, which results in the disorientation that I’ve mentioned. As I’ve mentioned in other discussions before, I would strongly prefer to have an actual navigation tree that shows where I am and what is before/after.

Note that this topic about navigation is more for XWiki.org Documentation Reorganization (batch 3)

This current thread is only about the location of extension documentation (main wiki vs exo wiki).

I’m going to mark it as solved since we agreed about the main wiki already. There are some details that remain but they’re smallish.

@elenicojocariu

As from the original proposal, the following suggestions are still pending implementation:

• Introducing a new xproperty in the Doc XClass to indicate if a documentation page belongs to a bundled or non-bundled extension.

We decided to implement this differently, by having a space for XS doc, vs non-bundled Extensions doc:

• https://www.xwiki.org/xwiki/bin/view/Doc/XS/ → doc for extensions bundled in XS
• https://www.xwiki.org/xwiki/bin/view/Doc/Extensions/ → doc for extensions not bundled in XS

@elenicojocariu

Replacing the Description field on exo with a display macro.

That’s still outstanding. I’m not sure we want a display macro because it’ll create a mess with the navigation. I much prefer that we simply add a “Documentation” button, next to the “Sources” and “Download” ones.

Thx