XWiki.org Documentation Reorganization (batch 4)

Development
,
1

Hi everyone,

We’re opening a new thread of discussion with the following small proposal:

Proposal 9: Nav vs Menu

Don’t put any content from the horizontal Menu of xwiki.org into the Navigation tree Panel, and don’t add Documentation XClass to these docs (they’re not targeted to a specific target user).

The rationale is:

  • Keep the Navigation Panel for the Documentation of XS
  • There’s no need to have the Menu entries in the Nav tree since the Menu is visible on all pages already.

Also:

  • Add the following docs to the horizontal menu (in About section). The main reason is that they’re not targeted to a specific user category and they’re not really XS documentation:
    • Compare with Confluence/MediaWiki
    • Active installs
  • Move the documentation pages for Snippets, Extensions, Commons, Rendering in the dev guide somewhere
  • Rework the “Projects” page to make it simpler to understand and to accomodate the arrival of Cristal in it, see Move Cristal from Contrib to XWiki proper
  • Move FAQ into documentation (as howtos, explanations pages, etc) and out of the horizontal menu.

Related

2

Could you please clarify what you mean by “menu” and “navigation tree”?

3

I’ve tried to improve the proposal. Please check it again. thx

4

Small change: I’d prefer that we keep snippets.xwiki.org separate from the XS doc ATM, since it contains unvalidated content.

5

More precisions:

The goal is to provide links to them from the horizontal menu, as right now:

6

It’s now been implemented.

7

+1, thank you!

1 Like
8

So what would be the behaviour then when accessing a page that belongs to “About” section? e.g. https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/SecondGenerationWiki/ we just hide the left panel, like we do in https://www.xwiki.org/xwiki/bin/view/Roadmaps/ to not see any navigation? or we display a closed navigation related to the Documentation, but we’re not in it so it’s weird?

Generally speaking I’d be ok with the proposal but it feels like it might create some inconsistencies depending on the pages we’re in.

9

This page is a doc page ATM and thus shouldn’t be displayed in the horizontal menu. We can decide if we keep it in the doc or if we move it outside of the XS documentation.

IMO it should remain in the XS documentation since it’s specific a single product (XS) and is not related to, say, Cristal, or some other products we may have in the forge.

Said differently, all links in the horizontal menu must work for all products (XS, Cristal, etc).

Now, related to your question about navigation, all pages in the horizontal menu should not have left panels (as it’s already the case).

ok for you @surli?

Thx

10

Yes as I said I’m ok in general.

11

Results:

  • Vincent, Eleni, Pauline, Lucas, Simon: +1

We’re finishing implementing it. Thx