Re: [xwiki-devs] [Proposal] 2 new rules for Application Best Practices

On Wed, Sep 30, 2015 at 10:22 AM, vincent(a)massol.net wrote: > Hi Denis, > > On 30 Sep 2015 at 09:49:28, Denis Gervalle (dgl@softec.lu(mailto:dgl@softec.lu)) wrote: > >> Well, I have not yet look in details the new features for page >> manipulation, but I was wondering if there will be a simple way to delete >> application data without deleting the application itself with the model you >> propose ? >> I know there is already issue with that about the WebHome which >> is usually an entry point to the application, but deleting a space was >> possible. If the code is nested under the data, isn't it an issue. It looks >> like the opposite of the general way (not xwiki way, but in application in >> general), where the code abstract more or less the location of the data and >> is the "main" part. >> >> So, I am not sure actually, that this is the best way. Maybe code and data >> should be side by side under a entry point documents ? > > You mean something like: > > MyApp > |_ Data/ > |_ Code/ > |_ WebHome > > (Instead of leaving it free for apps to decide where to put the data they generate) > > We could indeed standardize on the location of where an app puts the data it generates in a “Data" space. The problem with that is the forced /Data/ part of the URL which is really not nice.

> Even without this, to remove an app you’d simply remove the Code/ space (+ the WebHome). > > So your proposal of a standardized Data directory doesn’t contradict my proposal, it’s actually an additional proposal, so I guess you agree about the 2 rules? (you didn’t mention anything about rule 2). > > Thanks! > -Vincent > >> On Wed, Sep 30, 2015 at 8:22 AM, vincent(a)massol.net >> wrote: >> >> > Ping! There’s only Thomas and Gaby who answered so far :) >> > >> > >> > Thanks >> > -Vincent >> > >> > >> > On 27 Sep 2015 at 21:19:43, vincent(a)massol.net (vincent(a)massol.net) wrote: >> > >> > Hi devs, >> > >> > Following our implementation of NS/NP in 7.2 I’d like to propose 2 new >> > best practices for app dev that we would list at >> > http://dev.xwiki.org/xwiki/bin/view/Community/ApplicationDevelopmentBestPra… >> > >> > 1) New rule 1: “Code” subspace >> > >> > Current text: >> > * Generally, put all your pages in a single space dedicated for the >> > application you're developing (e.g. Faq, Scheduler, IRC, AppWithinMinutes, >> > etc). The name must be as short as possible while still being >> > understandable of course and without overusing abbreviations. >> > >> > New version: >> > * Generally, put all your pages in a single space dedicated for the >> > application you're developing (e.g. Faq, Scheduler, IRC, AppWithinMinutes, >> > etc). The name must be as short as possible while still being >> > understandable of course and without overusing abbreviations. >> > * Technical pages should be put in a subspace named “Code” >> > >> > Note: this rule can only be applied for new applications for now since the >> > EM doesn’t know how to follow renames currently so for example if I move >> > pages from the FAQCode space to the FAQ.Code space, when EM upgrades the >> > app, it’ll display all pages in FAQCode as deleted (basically it considers >> > all pages in FAQ.Code as new pages and pages in FAQCode as deleted pages). >> > Note: I’ve created http://jira.xwiki.org/browse/XWIKI-12622 for this. >> > >> > 2) New rule 2: >> > >> > * Technical pages without children must be terminal pages. >> > >> > WDYT? >> > >> > Thanks >> > -Vincent