Hi Vincent, Yes I wanted to separate both activities: - pure administration of the app: creation of all needed configuration items (servers, lists, types), and configuration of app behaviour (parameters) - operations: the activity of loading emails, scheduling loading sessions, purging loaded emails using filters, performing some batch operations on loaded items, ... - users: just navigating through loaded emails/topics, replying to emails, etc (point&click activity) The admin works on the configuration, while the "operator" works on the data. I agree that both activities are quite close and will usually be performed by the same guy, but both parts being quite rich, I thought interesting to separate them (many things are missing from this version of operations guide). By the way there could be a developer's guide, but it would be a bit premature :) There are some fragments in the dependent modules. Now, for xwiki, I'm not sure if it would be pertinent to separate admin & operations ... Br, Jeremie 2012/9/14 Vincent Massol <[email protected]>:
Hi again Jeremie,
I'm curious to understand the difference between Operations Guide and User Guide or Admin Guide.
On platform.xwiki.org we provide only 3 guides: User, Developer, Admin. Since you've defined a 4th category, I'm curious to see if we're missing something :)
Thanks -Vincent
On Sep 14, 2012, at 1:54 PM, Vincent Massol <[email protected]> wrote:
Hi Jeremie,
Re images you add, it would be nice if you could use the {{image}} macro. We use it everywhere and that allows us to have consistency in images we publish.
Thanks -Vincent
On Sep 14, 2012, at 9:15 AM, Vincent Massol <[email protected]> wrote:
On Sep 14, 2012, at 9:13 AM, Jeremie BOUSQUET <[email protected]> wrote:
I guess I have to create an extension page for each artifact ? (mail extension, mailarchive api extension, mail archive ui extension) Didn't had time to test within extension repository manager locally, so I hope it'll work ! :)
No don't create one per artifact. To start with I'd suggest just one for the UI module. The other artifacts are already in an extension repository since they're in maven.xwiki.org ;)
Thanks -Vincent
2012/9/13 Vincent Massol <[email protected]>:
I guess the next step is to create the extension page on e.x.o.
That'll be awesome and I'll start testing it when it's there! :)
Thanks -Vincent
On Sep 13, 2012, at 1:39 PM, Jeremie BOUSQUET <[email protected]> wrote:
Thanks ! No problem ...
2012/9/13 Vincent Massol <[email protected]>: > > On Sep 13, 2012, at 10:13 AM, Jeremie BOUSQUET <[email protected]> wrote: > >>> 2012/9/2 Jeremie BOUSQUET <[email protected]>: >>>> I could successfully deploy mail archive artifacts to nexus staging ! >>>> >>>> Would someone kindly promote it ? :) >> >> Hi, just to recall that to you ... :) >> (I know, seems a bit of a rush on 4.2 cycle and there is no urgency on >> my side, just want to avoid moving too deep in the mailing-list) > > Done! Sorry for the lag… > > -Vincent >> >> 2012/9/2 Jeremie BOUSQUET <[email protected]>: >>> (groupId : org.xwiki.contrib.mailarchive, version : 0.1, artifacts >>> xwiki-contrib-mail, xwiki-contrib-mailarchive-api, >>> xwiki-contrib-mailarchive-ui) >>> >> >> Thanks, >> Jeremie >> >>>> >>>> Thanks, >>>> Jeremie >>>> >>>> 2012/9/1 Jeremie BOUSQUET <[email protected]>: >>>>> Wow, eventually, it worked ... Had to switch to using >>>>> maven-release-plugin last version (2.3.2) instead of the one from >>>>> xwiki. >>>>> >>>>> Now I'm ... back to the initial issue with the enforcer : >>>>> >>>>> [WARNING] Rule 0: >>>>> org.apache.maven.plugins.enforcer.EvaluateBeanshell failed with >>>>> message: >>>>> Couldn't evaluate condition: ("pom" != "jar") || ("pom" == "jar" >>>>> && new java.io.File("C:\PRIVATE\Dropbox\MAILARCHIVE\target\checkout\target/xwiki-contrib-mailarchive-0.1-javado >>>>> c.jar").exists()) >>>>> [INFO] ------------------------------------------------------------------------ >>>>> >>>>> >>>>> Grrrr ! >>>>> >>>>> >>>>> 2012/9/1 Jeremie BOUSQUET <[email protected]>: >>>>>> I eventually was able to use push to git from maven with release >>>>>> plugin (had to reinstall git with more preservative options). >>>>>> >>>>>> But previous issue is still there: when checking-out my tag from local >>>>>> clone in target/checkout, pom.xml files are not there so there's >>>>>> nothing to build for maven ... >>>>>> >>>>>> 2012/9/1 Jeremie BOUSQUET <[email protected]>: >>>>>>> Progressing but still failing ... >>>>>>> >>>>>>> ... it's like a nightmare. >>>>>>> >>>>>>> I gave up pushing to github from maven, I think there's something >>>>>>> wrong with windows/mysysgit/cygwin somehow. >>>>>>> >>>>>>> Now trying to release tag "xwiki-contrib-mailarchive-0.1": >>>>>>> - it's pushed on github >>>>>>> - if I download the related zip (in "tag" tab on github), it's complete >>>>>>> - if I "release:perform" from maven, target/checkout folder contains >>>>>>> everything except pom.xml files ... of course release fails >>>>>>> >>>>>>> How can my pom.xml files be deleted when running "git checkout >>>>>>> xwiki-contrib-mailarchive-0.1", while I can see them in my local >>>>>>> history and on github ??? >>>>>>> >>>>>>> >>>>>>> 2012/8/31 Jeremie BOUSQUET <[email protected]>: >>>>>>>> I tried both, but not tried exhaustively possible combinations >>>>>>>> (ssh/https, maven/git conf, and my network proxy that comes in the way >>>>>>>> ...) >>>>>>>> BTW I'm not sure about how credentials for github should be fed to >>>>>>>> maven depending on SSH/HTTPS url connection used. >>>>>>>> Authentication with keys works from git command-line to push to >>>>>>>> github, but I think I miss some configuration maven-side. >>>>>>>> Actually from maven "git push" time-outs, or freezes forever, >>>>>>>> depending on protocol used. >>>>>>>> >>>>>>>> >>>>>>>> 2012/8/31 Thomas Mortagne <[email protected]>: >>>>>>>>> On Fri, Aug 31, 2012 at 9:17 AM, Jeremie BOUSQUET >>>>>>>>> <[email protected]> wrote: >>>>>>>>>> Hi Community, >>>>>>>>>> >>>>>>>>>> I'm trying to release my contrib project to nexus staging but having >>>>>>>>>> difficulties. >>>>>>>>>> >>>>>>>>>> Couldn't manage to "git push" correctly from maven to github (though >>>>>>>>>> "git push" command-line works), so I use "-DpushChanges=false" during >>>>>>>>>> release:prepare and release:perform, and do a "git push" manually >>>>>>>>>> after release:prepare. >>>>>>>>> >>>>>>>>> You sure you <scm> is right ? I see you indicated the https in >>>>>>>>> <developerConnection>, you should probably use the ssh one instead. >>>>>>>>> >>>>>>>>>> >>>>>>>>>> Now getting that during release:perform (***** were added, it's a >>>>>>>>>> correct path behind) : >>>>>>>>>> >>>>>>>>>> [INFO] --- maven-enforcer-plugin:1.0.1:enforce >>>>>>>>>> (enforce-javadoc-exists) @ xwiki-contrib-mailarchive --- >>>>>>>>>> [WARNING] Rule 0: >>>>>>>>>> org.apache.maven.plugins.enforcer.EvaluateBeanshell failed with >>>>>>>>>> message: >>>>>>>>>> Couldn't evaluate condition: ("pom" != "jar") || ("pom" == "jar" >>>>>>>>>> && new java.io.File("C:\*****\target\checkout\target/xwiki-contrib-mailarchive-0.1-javadoc.jar").exists()) >>>>>>>>>> >>>>>>>>>> Of course javadoc does not exist at this level, as I'm trying to >>>>>>>>>> release from root aggregator. What I don't understand is why the >>>>>>>>>> enforcer rule fails ? Aggregator is of type "pom" as expected. >>>>>>>>>> >>>>>>>>>> My command-line was: >>>>>>>>>> >>>>>>>>>> mvn release:perform -DpushChanges=false >>>>>>>>>> -DconnectionUrl=scm:git:https://github.com/xwiki-contrib/xwiki-application-mailarchive.git >>>>>>>>>> -Dtag=xwiki-contrib-mailarchive-0.1 >>>>>>>>>> >>>>>>>>>> >>>>>>>>>> Thanks, >>>>>>>>>> Jeremie >>>>>>>>>> >>>>>>>>>> >>>>>>>>>> 2012/8/17 Jeremie BOUSQUET <[email protected]>: >>>>>>>>>>> Hi Vincent, >>>>>>>>>>> >>>>>>>>>>> I saw that, no problem I'll update the groupId before doing the release :) >>>>>>>>>>> >>>>>>>>>>> Br, >>>>>>>>>>> Jeremie >>>>>>>>>>> >>>>>>>>>>> 2012/8/16 Vincent Massol <[email protected]>: >>>>>>>>>>>> Hi Jeremie, >>>>>>>>>>>> >>>>>>>>>>>> In case you haven't followed we've updated the contrib rule for the maven group id, see >>>>>>>>>>>> http://contrib.xwiki.org/xwiki/bin/view/Main/WebHome >>>>>>>>>>>> >>>>>>>>>>>> It would be great if you could update your groupid before you do the first release :) >>>>>>>>>>>> >>>>>>>>>>>> Thanks >>>>>>>>>>>> -Vincent >>>>>>>>>>>> >>>>>>>>>>>> On Aug 16, 2012, at 9:50 AM, Jeremie BOUSQUET wrote: >>>>>>>>>>>> >>>>>>>>>>>>> Thanks Vincent & Sergiu, >>>>>>>>>>>>> >>>>>>>>>>>>> So, is it ok if I put docs to >>>>>>>>>>>>> http://extensions.xwiki.org/xwiki/bin/view/MailArchive/Documentation >>>>>>>>>>>>> (and others in same space) ? >>>>>>>>>>>>> >>>>>>>>>>>>> By now I've almost finished writing first versions of: >>>>>>>>>>>>> * MailArchive.Documentation (home page) >>>>>>>>>>>>> * MailArchive.UserGuide >>>>>>>>>>>>> * MailArchive.AdminGuide >>>>>>>>>>>>> * MailArchive.OperationsGuide >>>>>>>>>>>>> * MailArchive.TroubleShooting >>>>>>>>>>>>> >>>>>>>>>>>>> I should be able to release 0.1 soon ... >>>>>>>>>>>>> >>>>>>>>>>>>> Br, >>>>>>>>>>>>> Jeremie >>>>>>>>>>>>> >>>>>>>>>>>>> 2012/8/13 Thomas Mortagne <[email protected]>: >>>>>>>>>>>>>> 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
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs