[xwiki-devs] [Proposal] XWiki.org skin improvements
Hi devs, While thinking about what features a Technical Documentation Flavor [1] should have, I came up with some ideas that we could integrate inside xwiki.org in order to make it a better documentation website: - navigation tree in the left panel, see -- http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen... compared to -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation - simpler skin (at least remove the comments area - lots of deprecated questions/answers and we have now the forum for that) - simpler menu (less entries + merge with the navbar if technical possible now, otherwise wait for newer version) - simpler footer area by removing the number of links displayed (we need to look at mouseflow) Would be great also to upgrade XWiki.org to a newer version. There were all sorts of ideas in the past like: - displaying 'Edit' also for unregistered in order to encourage edits - display 'Register'/'Log-in' links in the navbar in order to encourage edits these are not part of the current proposal, but keep the ideas coming :) we will try to implement them when we can. Of course it would be great if we would had time to: - update the docs content - reorganize pages - update the blog styling - etc. but I guess small changes will come in time. Let me know what you think, Caty [1] http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/TechnicalDocumentati...
We would really need to redesign the Documentation page since it's one of the most used pages. On Fri, Aug 11, 2017 at 2:51 PM, Ecaterina Moraru (Valica) < [email protected]> wrote:
Hi devs,
While thinking about what features a Technical Documentation Flavor [1] should have, I came up with some ideas that we could integrate inside xwiki.org in order to make it a better documentation website: - navigation tree in the left panel, see -- http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_partial.png compared to -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation - simpler skin (at least remove the comments area - lots of deprecated questions/answers and we have now the forum for that) - simpler menu (less entries + merge with the navbar if technical possible now, otherwise wait for newer version) - simpler footer area by removing the number of links displayed (we need to look at mouseflow)
Would be great also to upgrade XWiki.org to a newer version.
There were all sorts of ideas in the past like: - displaying 'Edit' also for unregistered in order to encourage edits - display 'Register'/'Log-in' links in the navbar in order to encourage edits these are not part of the current proposal, but keep the ideas coming :) we will try to implement them when we can.
Of course it would be great if we would had time to: - update the docs content - reorganize pages - update the blog styling - etc. but I guess small changes will come in time.
Let me know what you think, Caty
[1] http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ TechnicalDocumentationFlavor/
Hi Caty,
On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) <[email protected]> wrote:
Hi devs,
While thinking about what features a Technical Documentation Flavor [1] should have, I came up with some ideas that we could integrate inside xwiki.org in order to make it a better documentation website: - navigation tree in the left panel, see -- http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen...
As already discussed with you, I really like this screenshot. I find the UI to be very clean and simple and the navigation on the left is perfect for a documentation web site.
compared to -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation - simpler skin (at least remove the comments area - lots of deprecated questions/answers and we have now the forum for that) - simpler menu (less entries + merge with the navbar if technical possible now, otherwise wait for newer version) - simpler footer area by removing the number of links displayed (we need to look at mouseflow)
Would be great also to upgrade XWiki.org to a newer version.
Yep.
There were all sorts of ideas in the past like: - displaying 'Edit' also for unregistered in order to encourage edits - display 'Register'/'Log-in' links in the navbar in order to encourage edits these are not part of the current proposal, but keep the ideas coming :) we will try to implement them when we can.
Of course it would be great if we would had time to: - update the docs content - reorganize pages - update the blog styling - etc. but I guess small changes will come in time.
Let me know what you think,
I’m really excited by this. I also believe a new L&F is needed for xwiki.org (been several years that it’s not been changed and novelty is nice). I think you should start implementing this skin on xwiki.org if you can find some time and on my side I’m willing to help to move/reorganize the content around (which will be needed as soon as we display the navigation menu on the left). Anyone else interested to help out too? Thanks -Vincent
Caty
[1] http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/TechnicalDocumentati...
Hi, Proposal for AdminGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen... Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/ Thanks, Caty On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <[email protected]> wrote:
Hi Caty,
On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) <[email protected]> wrote:
Hi devs,
While thinking about what features a Technical Documentation Flavor [1] should have, I came up with some ideas that we could integrate inside xwiki.org in order to make it a better documentation website: - navigation tree in the left panel, see -- http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_partial.png
As already discussed with you, I really like this screenshot. I find the UI to be very clean and simple and the navigation on the left is perfect for a documentation web site.
compared to -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation - simpler skin (at least remove the comments area - lots of deprecated questions/answers and we have now the forum for that) - simpler menu (less entries + merge with the navbar if technical possible now, otherwise wait for newer version) - simpler footer area by removing the number of links displayed (we need to look at mouseflow)
Would be great also to upgrade XWiki.org to a newer version.
Yep.
There were all sorts of ideas in the past like: - displaying 'Edit' also for unregistered in order to encourage edits - display 'Register'/'Log-in' links in the navbar in order to encourage edits these are not part of the current proposal, but keep the ideas coming :) we will try to implement them when we can.
Of course it would be great if we would had time to: - update the docs content - reorganize pages - update the blog styling - etc. but I guess small changes will come in time.
Let me know what you think,
I’m really excited by this. I also believe a new L&F is needed for xwiki.org (been several years that it’s not been changed and novelty is nice).
I think you should start implementing this skin on xwiki.org if you can find some time and on my side I’m willing to help to move/reorganize the content around (which will be needed as soon as we display the navigation menu on the left).
Anyone else interested to help out too?
Thanks -Vincent
Caty
[1] http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ TechnicalDocumentationFlavor/
On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) <[email protected]> wrote:
Hi,
Proposal for AdminGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen...
So 3 sections: * Highlighted topics * Main topics * Other topics Sounds good to me. Thanks -Vincent
Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/
Thanks, Caty
On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <[email protected]> wrote:
Hi Caty,
On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) <[email protected]> wrote:
Hi devs,
While thinking about what features a Technical Documentation Flavor [1] should have, I came up with some ideas that we could integrate inside xwiki.org in order to make it a better documentation website: - navigation tree in the left panel, see -- http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_partial.png
As already discussed with you, I really like this screenshot. I find the UI to be very clean and simple and the navigation on the left is perfect for a documentation web site.
compared to -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation - simpler skin (at least remove the comments area - lots of deprecated questions/answers and we have now the forum for that) - simpler menu (less entries + merge with the navbar if technical possible now, otherwise wait for newer version) - simpler footer area by removing the number of links displayed (we need to look at mouseflow)
Would be great also to upgrade XWiki.org to a newer version.
Yep.
There were all sorts of ideas in the past like: - displaying 'Edit' also for unregistered in order to encourage edits - display 'Register'/'Log-in' links in the navbar in order to encourage edits these are not part of the current proposal, but keep the ideas coming :) we will try to implement them when we can.
Of course it would be great if we would had time to: - update the docs content - reorganize pages - update the blog styling - etc. but I guess small changes will come in time.
Let me know what you think,
I’m really excited by this. I also believe a new L&F is needed for xwiki.org (been several years that it’s not been changed and novelty is nice).
I think you should start implementing this skin on xwiki.org if you can find some time and on my side I’m willing to help to move/reorganize the content around (which will be needed as soon as we display the navigation menu on the left).
Anyone else interested to help out too?
Thanks -Vincent
Caty
[1] http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ TechnicalDocumentationFlavor/
Would be even better with some icons for each box, but nice proposal :) 2017-08-17 16:29 GMT+02:00 Vincent Massol <[email protected]>:
On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) <[email protected]> wrote:
Hi,
Proposal for AdminGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/AdminGuide.png
So 3 sections: * Highlighted topics * Main topics * Other topics
Sounds good to me.
Thanks -Vincent
Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/
Thanks, Caty
On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <[email protected]>
wrote:
Hi Caty,
On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) <[email protected]
wrote:
Hi devs,
While thinking about what features a Technical Documentation Flavor [1] should have, I came up with some ideas that we could integrate inside xwiki.org in order to make it a better documentation website: - navigation tree in the left panel, see -- http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/
TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_partial.png
As already discussed with you, I really like this screenshot. I find the UI to be very clean and simple and the navigation on the left is perfect for a documentation web site.
compared to -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation - simpler skin (at least remove the comments area - lots of deprecated questions/answers and we have now the forum for that) - simpler menu (less entries + merge with the navbar if technical possible now, otherwise wait for newer version) - simpler footer area by removing the number of links displayed (we
need
to
look at mouseflow)
Would be great also to upgrade XWiki.org to a newer version.
Yep.
There were all sorts of ideas in the past like: - displaying 'Edit' also for unregistered in order to encourage edits - display 'Register'/'Log-in' links in the navbar in order to encourage edits these are not part of the current proposal, but keep the ideas coming :) we will try to implement them when we can.
Of course it would be great if we would had time to: - update the docs content - reorganize pages - update the blog styling - etc. but I guess small changes will come in time.
Let me know what you think,
I’m really excited by this. I also believe a new L&F is needed for xwiki.org (been several years that it’s not been changed and novelty is nice).
I think you should start implementing this skin on xwiki.org if you can find some time and on my side I’m willing to help to move/reorganize the content around (which will be needed as soon as we display the navigation menu on the left).
Anyone else interested to help out too?
Thanks -Vincent
Caty
[1] http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ TechnicalDocumentationFlavor/
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
Hi, Proposal for DevGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen... Current: http://platform.xwiki.org/xwiki/bin/view/DevGuide/ If you have better grouping names/entries, let me know. Thanks, Caty On Thu, Aug 17, 2017 at 7:53 PM, Guillaume Delhumeau < [email protected]> wrote:
Would be even better with some icons for each box, but nice proposal :)
2017-08-17 16:29 GMT+02:00 Vincent Massol <[email protected]>:
On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) <[email protected]
wrote:
Hi,
Proposal for AdminGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/
TechnicalDocumentationFlavor/ExampleXWiki/WebHome/AdminGuide.png
So 3 sections: * Highlighted topics * Main topics * Other topics
Sounds good to me.
Thanks -Vincent
Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/
Thanks, Caty
On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <[email protected]>
wrote:
Hi Caty,
On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) <
wrote:
Hi devs,
While thinking about what features a Technical Documentation Flavor
[1]
should have, I came up with some ideas that we could integrate inside xwiki.org in order to make it a better documentation website: - navigation tree in the left panel, see -- http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_ doc_partial.png
As already discussed with you, I really like this screenshot. I find the UI to be very clean and simple and the navigation on the left is perfect for a documentation web site.
compared to -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation - simpler skin (at least remove the comments area - lots of deprecated questions/answers and we have now the forum for that) - simpler menu (less entries + merge with the navbar if technical possible now, otherwise wait for newer version) - simpler footer area by removing the number of links displayed (we need to look at mouseflow)
Would be great also to upgrade XWiki.org to a newer version.
Yep.
There were all sorts of ideas in the past like: - displaying 'Edit' also for unregistered in order to encourage edits - display 'Register'/'Log-in' links in the navbar in order to encourage edits these are not part of the current proposal, but keep the ideas coming :) we will try to implement them when we can.
Of course it would be great if we would had time to: - update the docs content - reorganize pages - update the blog styling - etc. but I guess small changes will come in time.
Let me know what you think,
I’m really excited by this. I also believe a new L&F is needed for xwiki.org (been several years that it’s not been changed and novelty is nice).
I think you should start implementing this skin on xwiki.org if you can find some time and on my side I’m willing to help to move/reorganize the content around (which will be needed as soon as we display the navigation menu on the left).
Anyone else interested to help out too?
Thanks -Vincent
Caty
[1] http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ TechnicalDocumentationFlavor/
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
Hi, Proposal for UserGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen... Current: http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/ Thanks, Caty On Thu, Aug 17, 2017 at 8:23 PM, Ecaterina Moraru (Valica) < [email protected]> wrote:
Hi,
Proposal for DevGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/DevGuide.png
Current: http://platform.xwiki.org/xwiki/bin/view/DevGuide/
If you have better grouping names/entries, let me know.
Thanks, Caty
On Thu, Aug 17, 2017 at 7:53 PM, Guillaume Delhumeau < [email protected]> wrote:
Would be even better with some icons for each box, but nice proposal :)
2017-08-17 16:29 GMT+02:00 Vincent Massol <[email protected]>:
On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) <
wrote:
Hi,
Proposal for AdminGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/
TechnicalDocumentationFlavor/ExampleXWiki/WebHome/AdminGuide.png
So 3 sections: * Highlighted topics * Main topics * Other topics
Sounds good to me.
Thanks -Vincent
Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/
Thanks, Caty
On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <[email protected]>
wrote:
Hi Caty,
On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) <
wrote:
Hi devs,
While thinking about what features a Technical Documentation Flavor
[1]
should have, I came up with some ideas that we could integrate inside xwiki.org in order to make it a better documentation website: - navigation tree in the left panel, see -- http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_ partial.png
As already discussed with you, I really like this screenshot. I find the UI to be very clean and simple and the navigation on the left is perfect for a documentation web site.
compared to -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation - simpler skin (at least remove the comments area - lots of deprecated questions/answers and we have now the forum for that) - simpler menu (less entries + merge with the navbar if technical possible now, otherwise wait for newer version) - simpler footer area by removing the number of links displayed (we need to look at mouseflow)
Would be great also to upgrade XWiki.org to a newer version.
Yep.
There were all sorts of ideas in the past like: - displaying 'Edit' also for unregistered in order to encourage edits - display 'Register'/'Log-in' links in the navbar in order to encourage edits these are not part of the current proposal, but keep the ideas coming :) we will try to implement them when we can.
Of course it would be great if we would had time to: - update the docs content - reorganize pages - update the blog styling - etc. but I guess small changes will come in time.
Let me know what you think,
I’m really excited by this. I also believe a new L&F is needed for xwiki.org (been several years that it’s not been changed and novelty is nice).
I think you should start implementing this skin on xwiki.org if you can find some time and on my side I’m willing to help to move/reorganize the content around (which will be needed as soon as we display the navigation menu on the left).
Anyone else interested to help out too?
Thanks -Vincent
Caty
[1] http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ TechnicalDocumentationFlavor/
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
Hi,
On 18 Aug 2017, at 15:28, Ecaterina Moraru (Valica) <[email protected]> wrote:
Hi,
Proposal for UserGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen...
It’s nice and I like it but it has a cost: we need to redo all videos since they’re old. Thanks -Vincent
Current: http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/
Thanks, Caty
On Thu, Aug 17, 2017 at 8:23 PM, Ecaterina Moraru (Valica) < [email protected]> wrote:
Hi,
Proposal for DevGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/DevGuide.png
Current: http://platform.xwiki.org/xwiki/bin/view/DevGuide/
If you have better grouping names/entries, let me know.
Thanks, Caty
On Thu, Aug 17, 2017 at 7:53 PM, Guillaume Delhumeau < [email protected]> wrote:
Would be even better with some icons for each box, but nice proposal :)
2017-08-17 16:29 GMT+02:00 Vincent Massol <[email protected]>:
On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) <
wrote:
Hi,
Proposal for AdminGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/
TechnicalDocumentationFlavor/ExampleXWiki/WebHome/AdminGuide.png
So 3 sections: * Highlighted topics * Main topics * Other topics
Sounds good to me.
Thanks -Vincent
Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/
Thanks, Caty
On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <[email protected]>
wrote:
Hi Caty,
> On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) <
wrote: > > Hi devs, > > While thinking about what features a Technical Documentation Flavor
[1]
> should have, I came up with some ideas that we could integrate inside > xwiki.org in order to make it a better documentation website: > - navigation tree in the left panel, see > -- > http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_ partial.png
As already discussed with you, I really like this screenshot. I find the UI to be very clean and simple and the navigation on the left is perfect for a documentation web site.
> compared to > -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation > - simpler skin (at least remove the comments area - lots of deprecated > questions/answers and we have now the forum for that) > - simpler menu (less entries + merge with the navbar if technical possible > now, otherwise wait for newer version) > - simpler footer area by removing the number of links displayed (we need to > look at mouseflow) > > Would be great also to upgrade XWiki.org to a newer version.
Yep.
> There were all sorts of ideas in the past like: > - displaying 'Edit' also for unregistered in order to encourage edits > - display 'Register'/'Log-in' links in the navbar in order to encourage > edits > these are not part of the current proposal, but keep the ideas coming :) we > will try to implement them when we can. > > Of course it would be great if we would had time to: > - update the docs content > - reorganize pages > - update the blog styling > - etc. > but I guess small changes will come in time. > > Let me know what you think,
I’m really excited by this. I also believe a new L&F is needed for xwiki.org (been several years that it’s not been changed and novelty is nice).
I think you should start implementing this skin on xwiki.org if you can find some time and on my side I’m willing to help to move/reorganize the content around (which will be needed as soon as we display the navigation menu on the left).
Anyone else interested to help out too?
Thanks -Vincent
> Caty > > [1] > http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ TechnicalDocumentationFlavor/
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
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). Thanks, Caty On Fri, Aug 18, 2017 at 4:31 PM, Vincent Massol <[email protected]> wrote:
Hi,
On 18 Aug 2017, at 15:28, Ecaterina Moraru (Valica) <[email protected]> wrote:
Hi,
Proposal for UserGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/UserGuide.png
It’s nice and I like it but it has a cost: we need to redo all videos since they’re old.
Thanks -Vincent
Current: http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/
Thanks, Caty
On Thu, Aug 17, 2017 at 8:23 PM, Ecaterina Moraru (Valica) < [email protected]> wrote:
Hi,
Proposal for DevGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/DevGuide.png
Current: http://platform.xwiki.org/xwiki/bin/view/DevGuide/
If you have better grouping names/entries, let me know.
Thanks, Caty
On Thu, Aug 17, 2017 at 7:53 PM, Guillaume Delhumeau < [email protected]> wrote:
Would be even better with some icons for each box, but nice proposal :)
2017-08-17 16:29 GMT+02:00 Vincent Massol <[email protected]>:
On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) <
wrote:
Hi,
Proposal for AdminGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/
TechnicalDocumentationFlavor/ExampleXWiki/WebHome/AdminGuide.png
So 3 sections: * Highlighted topics * Main topics * Other topics
Sounds good to me.
Thanks -Vincent
Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/
Thanks, Caty
On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <[email protected]>
wrote:
> Hi Caty, > >> On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) <
> wrote: >> >> Hi devs, >> >> While thinking about what features a Technical Documentation Flavor
[1]
>> should have, I came up with some ideas that we could integrate inside >> xwiki.org in order to make it a better documentation website: >> - navigation tree in the left panel, see >> -- >> http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ > TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_ partial.png > > As already discussed with you, I really like this screenshot. I find the > UI to be very clean and simple and the navigation on the left is perfect > for a documentation web site. > >> compared to >> -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/
Installation
>> - simpler skin (at least remove the comments area - lots of deprecated >> questions/answers and we have now the forum for that) >> - simpler menu (less entries + merge with the navbar if technical > possible >> now, otherwise wait for newer version) >> - simpler footer area by removing the number of links displayed (we need > to >> look at mouseflow) >> >> Would be great also to upgrade XWiki.org to a newer version. > > Yep. > >> There were all sorts of ideas in the past like: >> - displaying 'Edit' also for unregistered in order to encourage edits >> - display 'Register'/'Log-in' links in the navbar in order to encourage >> edits >> these are not part of the current proposal, but keep the ideas coming :) > we >> will try to implement them when we can. >> >> Of course it would be great if we would had time to: >> - update the docs content >> - reorganize pages >> - update the blog styling >> - etc. >> but I guess small changes will come in time. >> >> Let me know what you think, > > I’m really excited by this. I also believe a new L&F is needed for > xwiki.org (been several years that it’s not been changed and novelty is > nice). > > I think you should start implementing this skin on xwiki.org if you can > find some time and on my side I’m willing to help to move/reorganize the > content around (which will be needed as soon as we display the navigation > menu on the left). > > Anyone else interested to help out too? > > Thanks > -Vincent > > >> Caty >> >> [1] >> http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ > TechnicalDocumentationFlavor/ > >
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
On 18 Aug 2017, at 15:48, Ecaterina Moraru (Valica) <[email protected]> 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. Thanks -Vincent
Thanks, Caty
On Fri, Aug 18, 2017 at 4:31 PM, Vincent Massol <[email protected]> wrote:
Hi,
On 18 Aug 2017, at 15:28, Ecaterina Moraru (Valica) <[email protected]> wrote:
Hi,
Proposal for UserGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/UserGuide.png
It’s nice and I like it but it has a cost: we need to redo all videos since they’re old.
Thanks -Vincent
Current: http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/
Thanks, Caty
On Thu, Aug 17, 2017 at 8:23 PM, Ecaterina Moraru (Valica) < [email protected]> wrote:
Hi,
Proposal for DevGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/DevGuide.png
Current: http://platform.xwiki.org/xwiki/bin/view/DevGuide/
If you have better grouping names/entries, let me know.
Thanks, Caty
On Thu, Aug 17, 2017 at 7:53 PM, Guillaume Delhumeau < [email protected]> wrote:
Would be even better with some icons for each box, but nice proposal :)
2017-08-17 16:29 GMT+02:00 Vincent Massol <[email protected]>:
> On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) <
wrote: > > Hi, > > Proposal for AdminGuide: > http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/AdminGuide.png
So 3 sections: * Highlighted topics * Main topics * Other topics
Sounds good to me.
Thanks -Vincent
> > Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/ > > Thanks, > Caty > > On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <[email protected]> wrote: > >> Hi Caty, >> >>> On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) < [email protected] > >> wrote: >>> >>> Hi devs, >>> >>> While thinking about what features a Technical Documentation Flavor [1] >>> should have, I came up with some ideas that we could integrate inside >>> xwiki.org in order to make it a better documentation website: >>> - navigation tree in the left panel, see >>> -- >>> http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ >> TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_ partial.png >> >> As already discussed with you, I really like this screenshot. I find the >> UI to be very clean and simple and the navigation on the left is perfect >> for a documentation web site. >> >>> compared to >>> -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/
Installation
>>> - simpler skin (at least remove the comments area - lots of deprecated >>> questions/answers and we have now the forum for that) >>> - simpler menu (less entries + merge with the navbar if technical >> possible >>> now, otherwise wait for newer version) >>> - simpler footer area by removing the number of links displayed (we need >> to >>> look at mouseflow) >>> >>> Would be great also to upgrade XWiki.org to a newer version. >> >> Yep. >> >>> There were all sorts of ideas in the past like: >>> - displaying 'Edit' also for unregistered in order to encourage edits >>> - display 'Register'/'Log-in' links in the navbar in order to encourage >>> edits >>> these are not part of the current proposal, but keep the ideas coming :) >> we >>> will try to implement them when we can. >>> >>> Of course it would be great if we would had time to: >>> - update the docs content >>> - reorganize pages >>> - update the blog styling >>> - etc. >>> but I guess small changes will come in time. >>> >>> Let me know what you think, >> >> I’m really excited by this. I also believe a new L&F is needed for >> xwiki.org (been several years that it’s not been changed and novelty is >> nice). >> >> I think you should start implementing this skin on xwiki.org if you can >> find some time and on my side I’m willing to help to move/reorganize the >> content around (which will be needed as soon as we display the navigation >> menu on the left). >> >> Anyone else interested to help out too? >> >> Thanks >> -Vincent >> >> >>> Caty >>> >>> [1] >>> http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ >> TechnicalDocumentationFlavor/ >> >>
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
Hi, And the last batch from the Documentation 'saga': Proposal for Getting Started: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen... Current Getting Started: http://enterprise.xwiki.org/xwiki/bin/view/GettingStarted/ --------- Proposal for Documentation: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/TechnicalDocumen... Current Documentation: http://www.xwiki.org/xwiki/bin/view/Main/Documentation Thanks, Caty P.S: Icons for Guillaume and Eduard :) On Fri, Aug 18, 2017 at 5:01 PM, Vincent Massol <[email protected]> wrote:
On 18 Aug 2017, at 15:48, Ecaterina Moraru (Valica) <[email protected]> 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.
Thanks -Vincent
Thanks, Caty
On Fri, Aug 18, 2017 at 4:31 PM, Vincent Massol <[email protected]>
wrote:
Hi,
On 18 Aug 2017, at 15:28, Ecaterina Moraru (Valica) <[email protected]
wrote:
Hi,
Proposal for UserGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/
TechnicalDocumentationFlavor/ExampleXWiki/WebHome/UserGuide.png
It’s nice and I like it but it has a cost: we need to redo all videos since they’re old.
Thanks -Vincent
Current: http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/
Thanks, Caty
On Thu, Aug 17, 2017 at 8:23 PM, Ecaterina Moraru (Valica) < [email protected]> wrote:
Hi,
Proposal for DevGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/DevGuide.png
Current: http://platform.xwiki.org/xwiki/bin/view/DevGuide/
If you have better grouping names/entries, let me know.
Thanks, Caty
On Thu, Aug 17, 2017 at 7:53 PM, Guillaume Delhumeau < [email protected]> wrote:
Would be even better with some icons for each box, but nice proposal
:)
2017-08-17 16:29 GMT+02:00 Vincent Massol <[email protected]>:
> >> On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) < [email protected]> > wrote: >> >> Hi, >> >> Proposal for AdminGuide: >> http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ > TechnicalDocumentationFlavor/ExampleXWiki/WebHome/AdminGuide.png > > So 3 sections: > * Highlighted topics > * Main topics > * Other topics > > Sounds good to me. > > Thanks > -Vincent > >> >> Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/ >> >> Thanks, >> Caty >> >> On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol <
> wrote: >> >>> Hi Caty, >>> >>>> On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) < [email protected] >> >>> wrote: >>>> >>>> Hi devs, >>>> >>>> While thinking about what features a Technical Documentation Flavor [1] >>>> should have, I came up with some ideas that we could integrate inside >>>> xwiki.org in order to make it a better documentation website: >>>> - navigation tree in the left panel, see >>>> -- >>>> http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ >>> TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_ partial.png >>> >>> As already discussed with you, I really like this screenshot. I find the >>> UI to be very clean and simple and the navigation on the left is perfect >>> for a documentation web site. >>> >>>> compared to >>>> -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/ Installation >>>> - simpler skin (at least remove the comments area - lots of deprecated >>>> questions/answers and we have now the forum for that) >>>> - simpler menu (less entries + merge with the navbar if technical >>> possible >>>> now, otherwise wait for newer version) >>>> - simpler footer area by removing the number of links displayed (we > need >>> to >>>> look at mouseflow) >>>> >>>> Would be great also to upgrade XWiki.org to a newer version. >>> >>> Yep. >>> >>>> There were all sorts of ideas in the past like: >>>> - displaying 'Edit' also for unregistered in order to encourage edits >>>> - display 'Register'/'Log-in' links in the navbar in order to encourage >>>> edits >>>> these are not part of the current proposal, but keep the ideas coming > :) >>> we >>>> will try to implement them when we can. >>>> >>>> Of course it would be great if we would had time to: >>>> - update the docs content >>>> - reorganize pages >>>> - update the blog styling >>>> - etc. >>>> but I guess small changes will come in time. >>>> >>>> Let me know what you think, >>> >>> I’m really excited by this. I also believe a new L&F is needed for >>> xwiki.org (been several years that it’s not been changed and novelty is >>> nice). >>> >>> I think you should start implementing this skin on xwiki.org if you can >>> find some time and on my side I’m willing to help to move/reorganize the >>> content around (which will be needed as soon as we display the > navigation >>> menu on the left). >>> >>> Anyone else interested to help out too? >>> >>> Thanks >>> -Vincent >>> >>> >>>> Caty >>>> >>>> [1] >>>> http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ >>> TechnicalDocumentationFlavor/ >>> >>> > >
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
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? - Not sure why Release Notes and Roadmap are on main wiki and not on Devs. Thanks, Caty On Fri, Aug 18, 2017 at 7:06 PM, Ecaterina Moraru (Valica) < [email protected]> wrote:
Hi,
And the last batch from the Documentation 'saga':
Proposal for Getting Started: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/GettingStarted.png
Current Getting Started: http://enterprise.xwiki.org/xwiki/bin/view/GettingStarted/
---------
Proposal for Documentation: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/Documentation.png
Current Documentation: http://www.xwiki.org/xwiki/bin/view/Main/Documentation
Thanks, Caty
P.S: Icons for Guillaume and Eduard :)
On Fri, Aug 18, 2017 at 5:01 PM, Vincent Massol <[email protected]> wrote:
On 18 Aug 2017, at 15:48, Ecaterina Moraru (Valica) <[email protected]> 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.
Thanks -Vincent
Thanks, Caty
On Fri, Aug 18, 2017 at 4:31 PM, Vincent Massol <[email protected]>
wrote:
Hi,
On 18 Aug 2017, at 15:28, Ecaterina Moraru (Valica) <
wrote:
Hi,
Proposal for UserGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/
TechnicalDocumentationFlavor/ExampleXWiki/WebHome/UserGuide.png
It’s nice and I like it but it has a cost: we need to redo all videos since they’re old.
Thanks -Vincent
Current: http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/
Thanks, Caty
On Thu, Aug 17, 2017 at 8:23 PM, Ecaterina Moraru (Valica) < [email protected]> wrote:
Hi,
Proposal for DevGuide: http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ TechnicalDocumentationFlavor/ExampleXWiki/WebHome/DevGuide.png
Current: http://platform.xwiki.org/xwiki/bin/view/DevGuide/
If you have better grouping names/entries, let me know.
Thanks, Caty
On Thu, Aug 17, 2017 at 7:53 PM, Guillaume Delhumeau < [email protected]> wrote:
> Would be even better with some icons for each box, but nice
proposal :)
> > 2017-08-17 16:29 GMT+02:00 Vincent Massol <[email protected]>: > >> >>> On 17 Aug 2017, at 16:14, Ecaterina Moraru (Valica) < > [email protected]> >> wrote: >>> >>> Hi, >>> >>> Proposal for AdminGuide: >>> http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ >> TechnicalDocumentationFlavor/ExampleXWiki/WebHome/AdminGuide.png >> >> So 3 sections: >> * Highlighted topics >> * Main topics >> * Other topics >> >> Sounds good to me. >> >> Thanks >> -Vincent >> >>> >>> Current: http://platform.xwiki.org/xwiki/bin/view/AdminGuide/ >>> >>> Thanks, >>> Caty >>> >>> On Sat, Aug 12, 2017 at 3:12 PM, Vincent Massol < [email protected]> >> wrote: >>> >>>> Hi Caty, >>>> >>>>> On 11 Aug 2017, at 13:51, Ecaterina Moraru (Valica) < > [email protected] >>> >>>> wrote: >>>>> >>>>> Hi devs, >>>>> >>>>> While thinking about what features a Technical Documentation Flavor > [1] >>>>> should have, I came up with some ideas that we could integrate > inside >>>>> xwiki.org in order to make it a better documentation website: >>>>> - navigation tree in the left panel, see >>>>> -- >>>>> http://design.xwiki.org/xwiki/bin/download/Proposal/Flavors/ >>>> TechnicalDocumentationFlavor/ExampleXWiki/WebHome/xwiki_doc_ > partial.png >>>> >>>> As already discussed with you, I really like this screenshot. I find > the >>>> UI to be very clean and simple and the navigation on the left is > perfect >>>> for a documentation web site. >>>> >>>>> compared to >>>>> -- http://platform.xwiki.org/xwiki/bin/view/AdminGuide/ Installation >>>>> - simpler skin (at least remove the comments area - lots of > deprecated >>>>> questions/answers and we have now the forum for that) >>>>> - simpler menu (less entries + merge with the navbar if technical >>>> possible >>>>> now, otherwise wait for newer version) >>>>> - simpler footer area by removing the number of links displayed (we >> need >>>> to >>>>> look at mouseflow) >>>>> >>>>> Would be great also to upgrade XWiki.org to a newer version. >>>> >>>> Yep. >>>> >>>>> There were all sorts of ideas in the past like: >>>>> - displaying 'Edit' also for unregistered in order to encourage > edits >>>>> - display 'Register'/'Log-in' links in the navbar in order to > encourage >>>>> edits >>>>> these are not part of the current proposal, but keep the ideas > coming >> :) >>>> we >>>>> will try to implement them when we can. >>>>> >>>>> Of course it would be great if we would had time to: >>>>> - update the docs content >>>>> - reorganize pages >>>>> - update the blog styling >>>>> - etc. >>>>> but I guess small changes will come in time. >>>>> >>>>> Let me know what you think, >>>> >>>> I’m really excited by this. I also believe a new L&F is needed for >>>> xwiki.org (been several years that it’s not been changed and > novelty is >>>> nice). >>>> >>>> I think you should start implementing this skin on xwiki.org if you > can >>>> find some time and on my side I’m willing to help to move/reorganize > the >>>> content around (which will be needed as soon as we display the >> navigation >>>> menu on the left). >>>> >>>> Anyone else interested to help out too? >>>> >>>> Thanks >>>> -Vincent >>>> >>>> >>>>> Caty >>>>> >>>>> [1] >>>>> http://design.xwiki.org/xwiki/bin/view/Proposal/Flavors/ >>>> TechnicalDocumentationFlavor/ >>>> >>>> >> >> > > > -- > Guillaume Delhumeau ([email protected]) > Research & Development Engineer at XWiki SAS > Committer on the XWiki.org project >
Hi, Replying a bit late, but here are my thoughts, On 08/21/2017 06:15 PM, Ecaterina Moraru (Valica) wrote:
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 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 …
- 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) <[email protected]> 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
On Tue, Aug 22, 2017 at 10:39 PM, Clément Aubin <[email protected]> wrote:
Hi, Replying a bit late, but here are my thoughts,
On 08/21/2017 06:15 PM, Ecaterina Moraru (Valica) wrote:
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).
Some might disagree with that :)
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 …
- 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) < [email protected]> 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.
There is some work done in a related direction on the Multi Page Tours.
Thanks -Vincent
The documentation design looks really really nice !
Thank you, Caty
Thanks !
Clément
participants (4)
-
Clément Aubin -
Ecaterina Moraru (Valica) -
Guillaume Delhumeau -
Vincent Massol