On Mon, Aug 13, 2012 at 3:23 PM, Vincent Massol <[email protected]> wrote: > > On Aug 13, 2012, at 3:17 PM, Vincent Massol wrote: > >> Hi Jeremie and all, >> >> Back from holidays too :) Cool to see progress on this! >> >> Ok I've parsed this thread and here's my take: >> >> * JIRA: I'll create a dedicated JIRA project since the project seems large >> enough to warrant it > > ok, Thomas is doing it ATM, should be ready real soon :)
Done, http://jira.xwiki.org/browse/XMAILARCH. You should have the rights to do pretty much anything in this project. > >> * Documentation: our rule is currently to have pages on extensions.xwiki.org >> and if the project becomes too large to create a dedicated wiki for it, as >> we've done for rendering.xwiki.org, commons.xwiki.org, enterprise, etc for >> example (see http://contrib.xwiki.org/xwiki/bin/view/Main/WebHome). IMO it's >> ok ATM to have several pages on e.x.o for the MailArchive application and we >> can decide later on to move it to its own wiki (after we have a 1.0 released >> IMO). >> * Nexus: I'll create an account for you. > > I see you already have a user, cool. > > Thanks > -Vincent > >> Is that ok? >> >> Thanks >> -Vincent >> >> On Aug 10, 2012, at 9:51 AM, Jeremie BOUSQUET wrote: >> >>>> So I'd say that: >>>> >>>> - There should be some documentation on the extension page, at least a >>>> description of the project, some usage scenarios, some screenshots, and a >>>> list of the features >>>> - I agree that the full documentation should be included in the application >>>> itself >>>> - The same full documentation should also be available online, and the >>>> contrib wiki seems to be the right place (in a dedicated space) >>> >>> I think it's the best solution. >>> Since the space I currently use for the main pages of my app is >>> "MailArchive", I would propose to use the same for the documentation >>> space and put pages under: >>> http://contrib.xwiki.org/xwiki/bin/view/MailArchive/ >>> >>> That way publishing the doc online to contrib wiki would be >>> straightforward with selective import. >>> >>> Br, >>> Jeremie >>> >>> 2012/8/9 Sergiu Dumitriu <[email protected]>: >>>> On 08/09/2012 10:38 AM, Jerome Velociter wrote: >>>>> >>>>> On 08/09/2012 04:34 PM, Jeremie BOUSQUET wrote: >>>>>> >>>>>> Humm ... Just thinking I might put that directly inside my app xar ... >>>>>> WDYT ? >>>>> >>>>> >>>>> I'm a big fan of self-documenting applications. It has the great >>>>> advantage of always offering documentation matching the version in use. >>>>> >>>>> But you might also want to offer the latest released version >>>>> documentation online. I think there are some extensions that have >>>>> documentation that spans several pages, but honestly I don't know if >>>>> this is something we want/we agreed upon. I'll leave it to others to >>>>> bring more information on this subject. There is the contrib wiki also >>>>> which could be a candidate. >>>>> >>>> >>>> I've seen extensions with a lot of documentation on their extension page, >>>> and I've seen things documented in several places. Personally, I don't like >>>> huge extension pages. >>>> >>>> So I'd say that: >>>> >>>> - There should be some documentation on the extension page, at least a >>>> description of the project, some usage scenarios, some screenshots, and a >>>> list of the features >>>> - I agree that the full documentation should be included in the application >>>> itself >>>> - The same full documentation should also be available online, and the >>>> contrib wiki seems to be the right place (in a dedicated space) >>>> >>>> >>>>> >>>>>> >>>>>> 2012/8/9 Jeremie BOUSQUET <[email protected]>: >>>>>>> >>>>>>> Thanks Jerome, >>>>>>> >>>>>>> Another thing about this project: I'd like to prepare things, and >>>>>>> particularly the user guide part, so it's available when I'll publish >>>>>>> the extension. >>>>>>> For this particular use-case though, I'd like to extend the user/admin >>>>>>> guide part on more than one page, as it may be quite large. >>>>>>> Where should I put these pages ? >>>>>>> >>>>>>> Thanks, >>>>>>> Jeremie >> > > _______________________________________________ > devs mailing list > [email protected] > http://lists.xwiki.org/mailman/listinfo/devs -- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
