23 Oct
2015
23 Oct
'15
3:03 p.m.
Hi,
On 22 Oct 2015 at 15:46:01, Marius Dumitru Florea
(mariusdumitru.florea@xwiki.com(mailto:mariusdumitru.florea@xwiki.com)) wrote:
On Wed, Sep 30, 2015 at 10:48 AM, Denis Gervalle
wrote:
I think it’s nice to have Data/ and Code because it provides a clear structure. I was
worried about the URL but we think it’s not a problem then I’m fine too. After all it’s
generated data and not content pages so it’s probably ok to have a bit more technical URL.
And in any case we need some URL alias features in the future.
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 ?
Most applications generate structured data so if you know the application
xclass then it's easy to write a query that selects all the application
entries (excluding the template) from any given location (application
space, data space, whatever). Deleting the application entries is not a
problem IMO. The problem is setting different access rights for the code
space and the data space. If the code space is nested inside the data space
then you need to be careful with the rights inheritance. So I'm +1 for
App
|- Code
|- Data
Having /Data/ in the URL is not a big issue for me. What can be an issue is
having the word "Data" in the breadcrumbs. But we could partially fix this
by setting a title on the Data.WebHome using a translation key whose value
can be set by the application creator. The following is acceptable IMO:
Mocca Calendar / Events / Seminar 2015
Weekly Activity / Reports / Week 18 to 24 August
Task Manager / Tasks / Improve the marketing page
FAQ / Questions / What is the meaning of life
but there are applications where this doesn't look good
Meeting / Meetings / Roadmap 7.3
Ideas / Ideas / Send people to Mars
so the application creator will have to settle for
Ideas / Entries / Send people to Mars
Indeed. So default rule would be Entries and if possible find a more application-oriented
name.
Looks good to me.
Thanks
-Vincent
Thanks,
Marius
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 ?
>
> 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