Re: [xwiki-devs] [ANN] Release of Limits Application 1.2.

[Eduard Moraru]

Thanks, Guillaume!

-Eduard

On Mon, Sep 19, 2016 at 6:55 PM, Guillaume Delhumeau <
guillaume.delhum...@xwiki.com> wrote:

> Hi users and devs,
>
> The Limits Application has been improved again. It seems I have taken the
> manta "release early, release often" very seriously :).
>
> The 1.2 version has been released and brings the ability to handle custom
> limits.
>
> See: http://extensions.xwiki.org/xwiki/bin/view/Extension/
> Limits+Application
>
> Thanks,
>
> --
> Guillaume Delhumeau (guillaume.delhum...@xwiki.com)
> Research & Development Engineer at XWiki SAS
> Committer on the XWiki.org project
> ___
> devs mailing list
> devs@xwiki.org
> http://lists.xwiki.org/mailman/listinfo/devs
>
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] Release notes strategy for included contrib extensions

[Vincent Massol]

> On 19 Sep 2016, at 15:59, Ecaterina Moraru (Valica)  wrote:
> 
> We could have an "Extensions" section in the RN of XE where we could
> display noticeable functionalities. So that's your 1) variant.
> 
> My problem is that we have this discrepancy between RN and Documentation.
> So this means we would duplicate content to RN and Documentation, instead
> of reusing it.

It’s not duplication. One explains the changes (the RN) and the other explains 
the features.

The RN should not duplicate too much of the ref documentation and it should 
link to it.

Of course there’s always a bit of overlap like screenshots (which btw we don’t 
link since the screenshots in the ref doc change while they shouldn’t change 
over time on the RN page!).

This could be a key reason that RN and reference doc could not be the same! RN 
should not change so you can go back to it but reference doc can keep being 
improved, screenshots updated, etc. Unless you always use a revision number in 
your links/content and make sure to never loose the history.

Thanks
-Vincent

> Usually instead of duplicating it, we just put it in one
> place and link from the other. Maybe the "News and Worthy" application
> could improve this. Have some ReleaseNotes objects per version that could
> be integrated inside XE RN and Extensions documentation, and use them from
> the XE RN.
> 
> Thanks,
> Caty
> 
> On Mon, Sep 19, 2016 at 4:51 PM, Marius Dumitru Florea <
> mariusdumitru.flo...@xwiki.com> wrote:
> 
>> +1 for 1)
>> 
>> Thanks,
>> Marius
>> 
>> On Tue, Sep 13, 2016 at 7:23 PM, Vincent Massol 
>> wrote:
>> 
>>> Hi devs,
>>> 
>>> We now include a few contrib apps in XE. However, when someone checks the
>>> RN for XE, for example http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/
>>> ReleaseNotesXWiki83M2 all they see is this:
>>> 
>>> “The following dependencies have been upgraded:
>>> * Tour Application 1.0.4”
>>> 
>>> It doesn’t say if there are any substantial things added those deps.
>>> 
>>> I can think of 2 solutions:
>>> 
>>> 1) When something is noticeable, add it to the RN of XE. So for example
>> if
>>> CKEditor extension adds something new, users checking the RN of XE can
>> see
>>> it immediately.
>>> 
>>> 2) Link to the RN of the extension. However RN of extensions on e.x.o are
>>> not nice. They’re just lists of JIRA issues. So for this solution to be a
>>> bit satisfactory we would need to improve the RN of extensions, starting
>>> with those we bundle in XE. Another possibility is to say that for
>>> Recommended Extensions we pay an extra care to write nice Release Notes.
>>> But that’s harder to enforce and ensure.
>>> 
>>> Option 1) is my preference.
>>> 
>>> WDYT?
>>> 
>>> Thanks
>>> -Vincent
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] [ANN] LDAP extensions 9.1 have been released

[Vincent Massol]

> On 19 Sep 2016, at 18:18, Thomas Mortagne  wrote:
> 
> Hi xwikiers,
> 
> We decided to remove LDAP authenticator from XWiki Enterprise in 8.3.
> So I moved everything that was related to LDAP in
> https://github.com/xwiki-contrib/ldap. Don't worry It's still
> supported by the XWiki Dev team and  got many improvements already. It
> just felt easier to maintain and reuse it in its own repository and is
> very easy to install with Extension Manager.
> 
> I taken the occasion to "merge" the LDAP Authenticator and Trusted
> LDAP Authenticator so there is now only one with all the features of
> both authenticators plus a few bonuses.

Thanks Thomas, that’s great!

Shouldn’t we also make sure that devs now contribute to this new LDAP app 
instead of the old extensions? For example shouldn’t 
https://github.com/xwiki-contrib/xwiki-authenticator-trusted-ldap have an 
updated README to explain all this?

Thanks
-Vincent

> You can also use it since Wiki 7.4.x and get all the new features
> without upgrading. It won't conflict with the embedded one, you just
> indicate you want to use the new one which is fully retro-compatible.
> 
> See more details on
> http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP/ and
> http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP/Authenticator/.
> -- 
> Thomas Mortagne

___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] [Proposal] Release Notes Application

[Vincent Massol]

> On 19 Sep 2016, at 16:02, Ecaterina Moraru (Valica)  wrote:
> 
> Why don't we just improve this class
> http://extensions.xwiki.org/xwiki/bin/view/ExtensionCode/ExtensionVersionClass
> ?

Because it’s very different! Actually there isn’t a single field that is the 
same as my ChangesClass :)

> Maybe the difference is that this is per version and you kind of want per
> functionality.
> 
> But the 'Category' is not needed, since we have the extension page name.
> 
> The idea is that I would really want us to see if we could use this
> application also in the future, to document things for the extensions
> pages.

So, for this, I’ve added the notion of ‘Product” to the app. So you can now use 
it for the release notes of any number of products (and thus including for 
extensions with a separate versioning and release cycle).

We could imagine the extension page using the {{changes/}} macro to display the 
RN, or point with a link to the RN page for that product (i.e. extension).

Thanks
-Vincent

> Thanks,
> Caty

[snip]

___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] [Proposal] Release Notes Application

[Vincent Massol]

> On 19 Sep 2016, at 14:13, Ecaterina Moraru (Valica)  wrote:

[snip]

>> Future
>> ==
>> 
>> * Add a different release notes app to include the other metadata
>> * We could almost imagine using this “New and networthy” app to provide
>> reference documentation for our features… :) (along with automatic
>> “since”). That’s probably too science-fiction and I’m sure there are lots
>> of gotchas but just mentioning it here to make us dream a bit...
>> 
> 
> I don't see how what you are proposing is any different from the Features
> documentation. Maybe this is the way to finally merge the documentation
> instead of having it spread in e.x.o and RNs. I guess the only difference
> is where we store the objects/pages.

This is what I was saying above ;) Except that it’s not so easy and is a much 
bigger scope. What I propose is to start with the Release Notes application, 
and as data fills up, we can start experimenting with using it to generate 
reference documentation. I think the main issue we’ll have is that adding up 
changes doesn't generate good documentation. It only generates a 
randomly-ordered list of features with no narrative.

In any case if we think it has value, we’ll be able to use it (and even 
possibly refactor the Release Notes app and extract a Features app from it). 

But let’s take it one step at a time!

> The release notes presents information
> for a particular version, while feature documentation presents information
> for a particular feature/category.

This is actually the same for both. They both present by category and version. 
For the reference documentation we use “Since XWiki N.NN” for the version info).

> We could use the same objects, with
> different parameters to display both RN and Documentation.
> 
> Regarding the inspiration for your proposal, I find their release notes to
> be more interesting
> https://www.jetbrains.com/datagrip/whatsnew/#language-injections

I’ve refactored the app I started to support multiple displayer. I now have 
Grid + Flow. You choose the displayer as a macro parameter:

{{changes … displayer=“flow” …/}}
{{changes … displayer=“grid” …/}}

> For example they provide the "categories navigation" at the top and also
> they group multiple functionalities for a particular category together,
> using subheaders.

Don’t forget that currently our Release notes don’t present just Features (what 
I call Changes). They also present updated libs, tested stuff, translations, 
backward compat, etc). So in order to have a top nav as on the link you gave 
above, you’ll need to refactor the RN page and probably extract out the Changes 
part from it.

Now I agree that for a user the main info are the Changes and we could change 
the design of our RN and focus on Changes and have a “Advanced” section at the 
end with the rest.

This is where we’d need your help :)

> I like what you did with the prototype. Unfortunately it's a bit hard to
> read and focus on reading the content: mostly because it's a bit crowded
> (with the 2/3 columns layout) and the dark gallery background is very
> distracting. But the styling can be fixed and the most important part are
> the app and metadata.

Yes, don’t worry you’ll have plenty of work to make it nice-looking ;)

> The idea to present as note in the Miscellaneous section if it doesn't have
> a screenshot is interesting. But we could also consider that we might want
> to have some small category summaries, where we list just the text, without
> any screenshots.

I’d really like to force having always screenshots for user-related changes. 
Anything too small to not have a screenshot is a misc for me. And I think we 
should do that since it would help us make sure that we always have screenshots 
for user-related changes.

> Or that we might want to showcase just the screenshots.

I don’t see how hard it is to add just a few words describing the screenshot.

Note that since the screenshots are metadata if you want a report showing only 
screenshots that’s easy to do.

> But this are just small observations and can be improved with display
> parameters.
> 
> Regarding importance, we need to be careful not to duplicate many things
> that we have in the jira issue.

Following Marius’s comment, I’ve added an “Importance” xproperty to the app 
(with 3 levels; High, Medium, Low). We’ll see how it goes.

> A wild idea would be to assign per
> functionality a jira issue and the app could extract metadata from there
> (the importance, the category, the version, etc.) But that's SF :)

Yes and I’m not even sure it’s a good thing since JIRA is a tool to help 
development (the importance of an issue in jira doesn’t correspond to the 
importance a feature has for users).

Thanks
-Vincent

> Nice work Vincent.
> 
> Thanks,
> Caty
> 
> 
> 
>> 
>> I’m starting to work on the POC. Let me know what you think.
>> 
>> Thanks
>> -Vincent
___
devs mailing list
devs@xwiki.org

[xwiki-devs] [ANN] LDAP extensions 9.1 have been released

[Thomas Mortagne]

Hi xwikiers,

We decided to remove LDAP authenticator from XWiki Enterprise in 8.3.
So I moved everything that was related to LDAP in
https://github.com/xwiki-contrib/ldap. Don't worry It's still
supported by the XWiki Dev team and  got many improvements already. It
just felt easier to maintain and reuse it in its own repository and is
very easy to install with Extension Manager.

I taken the occasion to "merge" the LDAP Authenticator and Trusted
LDAP Authenticator so there is now only one with all the features of
both authenticators plus a few bonuses.

You can also use it since Wiki 7.4.x and get all the new features
without upgrading. It won't conflict with the embedded one, you just
indicate you want to use the new one which is fully retro-compatible.

See more details on
http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP/ and
http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP/Authenticator/.

-- 
Thomas Mortagne
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] [Proposal] Change our Script API best practice regarding exception handling (Take 2)

[Vincent Massol]

Hi,

This wasn’t a vote but everybody who replied agreed (Marius, Thomas, Vincent, 
Sergiu, Edy wasn’t thrilled but was ok too ;)), so let’s do it!

I’ve now documented it at 
http://extensions.xwiki.org/xwiki/bin/view/Extension/Script+Module#HBestPractices

So please make sure you code your Script Services so that they throw exceptions 
now :)

Thanks
-Vincent

> On 18 Jan 2016, at 11:03, vinc...@massol.net wrote:
> 
> Hi devs,
> 
> After a lot of thinking and experimentation (see the thread’s details), I 
> have found that this first proposal is not a good idea. I’m thus proposing to 
> replace it with the following best practice:
> 
> * Let our script services generate exceptions
> * If the velocity scripts with to handle the exceptions, then they should use 
> the #try() directive. If they don’t want to, they don’t have to do anything 
> since the MacroTransformation or the template (contentvars.vm for example) 
> will catch it and display it to the user.
> 
> More precisely I’m proposing that:
> 
> * Existing Script APIs in Java should not be modified as that would break 
> backward compatibility. New signatures can be added and old one deprecated 
> and moved to the legacy modules. After new signatures have been introduced, 
> existing velocity scripts can be updated to use the new signatures and to use 
> the #try directive if needed.
> * New Script APIs must use the new best practices (if agreed :)), i.e. throw 
> Exceptions, and new velocity scripts must use the #try() directive if they 
> need to handle exceptions.
> 
> WDYT?
> 
> Thanks
> -Vincent
> 
> 
> On 14 Jan 2016 at 17:51:04, vinc...@massol.net 
> (vinc...@massol.net(mailto:vinc...@massol.net)) wrote:
> 
>> Hi devs,  
>> 
>> Right now our strategy is for script services and script APIs in general to 
>> catch exceptions, store them and offer a getLastError() method to get them 
>> (see 
>> http://extensions.xwiki.org/xwiki/bin/view/Extension/Script+Module#HBestPractices)
>>   
>> 
>> However it would be much nicer to:  
>> * Let our script services generate exceptions
>> * Offer a velocity script service to get the last exception raised by a java 
>> call from velocity
>> * Implement this uberspector to catch the exceptions and to set them in the 
>> execution context
>> 
>> That should be quite easy to implement IMO.  
>> 
>> WDYT?  
>> 
>> Thanks  
>> -Vincent
>> 
>> PS: This is http://jira.xwiki.org/browse/XWIKI-2374
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

[xwiki-devs] [ANN] Release of Limits Application 1.2.

[Guillaume Delhumeau]

Hi users and devs,

The Limits Application has been improved again. It seems I have taken the
manta "release early, release often" very seriously :).

The 1.2 version has been released and brings the ability to handle custom
limits.

See: http://extensions.xwiki.org/xwiki/bin/view/Extension/Limits+Application

Thanks,

-- 
Guillaume Delhumeau (guillaume.delhum...@xwiki.com)
Research & Development Engineer at XWiki SAS
Committer on the XWiki.org project
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] Nested Pages - Search Links Not Working

[Keith Davis]

Well, that did not work. The quote style I created did not carry over at
all. Switched my subscription over to my Gmail account. We'll see if that
helps at all.

On Mon, Sep 19, 2016 at 9:44 AM, Keith Davis 
wrote:

> That’s easy to check thanks to archives:
>
> http://xwiki.markmail.org/search/?q=from%3Apridedallas.com
>
>
>
> Thanks, and I did find that today, but I was still skeptical.
>
>
>
> FTR I did answer some of your question(s).
>
>
>
> Yes, and you have been very helpful, Vincent, and I was wrong, someone
> (you)
> did respond once since my comments about the release notes, about
> xwiki.org
> being offline back in May. However, that is the only reply I've received in
> that time and I've sent a number of emails about issues we were having.
>
>
>
> One thing I noted though is that your last email is strangely displayed on
> the list:
>
> * It’s not threaded, see http://xwiki.markmail.org/thread/wo7v736e2suupjor
> .
> The other mails are in a different thread:
> http://xwiki.markmail.org/thread/ryh3igwjvhjqn6pz
>
> Not sure why that is happening either.
>
>
> * It’s hard to parse visually since there’s no clear visual separation from
> the original content and the reply (like using “>” for example. See how
> it’s
> more visible at http://markmail.org/message/zd2mepffue4lbrpb for an
> example). Examples:
>
> ** http://markmail.org/message/6l7zzlidbafc43tp
>
> ** http://markmail.org/message/wo7v736e2suupjor
>
>
>
> It probably doesn’t explain anything but could help make your emails more
> appealing.
>
>
>
> Yea, I’ve thought about that, but Outlook doesn’t do that by default. I
> just
> created a custom style to do that to see if it helps.
>
>
>
> Well as Maris said you’re using the community channel, not the one for
> professional services so it’s a bit normal that nobody replied to you when
> you asked  to pay someone ;)
>
>
>
> For paying options, see
> http://www.xwiki.org/xwiki/bin/view/Main/Support#HProfessionalSupport
>
>
>
> In short, you should contact the company. For XWiki SAS I guess you could
> use: http://www.xwiki.com/en/company/contact-us
>
>
>
> Did not know there was a “professional services” channel.
>
>
>
> Thanks for all of the input, Vincent.
>
>
>
>
>
> Keith Davis (214) 906-5183 - I.T. Director
>
>
>
>
>
> -Original Message-
> From: devs [mailto:devs-boun...@xwiki.org] On Behalf Of Vincent Massol
> Sent: Monday, September 19, 2016 8:09 AM
> To: XWiki Developers
> Subject: Re: [xwiki-devs] Nested Pages - Search Links Not Working
>
>
>
> Hi Keith,
>
>
>
> > On 19 Sep 2016, at 14:47, Keith Davis
> > > wrote:
>
> >
>
> > The main reason I posted to devs is because I have not received one
>
> > single response (until this one), for any issue I've posted in over 6
>
> > months - not one. I was concerned either nobody was getting my
>
> > requests
>
>
>
> That’s easy to check thanks to archives:
>
> http://xwiki.markmail.org/search/?q=from%3Apridedallas.com
>
>
>
> > or that I everyone was just ignoring me due to my previous comments.
>
>
>
> FTR I did answer some of your question(s).
>
>
>
> I don’t know why you didn’t get more answers.
>
>
>
> One thing I noted though is that your last email is strangely displayed on
> the list:
>
> * It’s not threaded, see http://xwiki.markmail.org/thread/wo7v736e2suupjor
> .
> The other mails are in a different thread:
> http://xwiki.markmail.org/thread/ryh3igwjvhjqn6pz
>
> * It’s hard to parse visually since there’s no clear visual separation from
> the original content and the reply (like using “>” for example. See how
> it’s
> more visible at http://markmail.org/message/zd2mepffue4lbrpb for an
> example). Examples:
>
> ** http://markmail.org/message/6l7zzlidbafc43tp
>
> ** http://markmail.org/message/wo7v736e2suupjor
>
>
>
> It probably doesn’t explain anything but could help make your emails more
> appealing.
>
>
>
> > I just wanted to make sure that I was actually being received, but I
> guess
> > I would get about this response if I was.
>
> >
>
> > I realize this is community support, but I've even offered to pay someone
> > for support and got zero takers. We depend on this Wiki as it's the only
> > one out there that really fits our needs. Thanks for responding. I'll
> wait
> > and see if any responds to my current issue.
>
>
>
> Well as Maris said you’re using the community channel, not the one for
> professional services so it’s a bit normal that nobody replied to you when
> you asked  to pay someone ;)
>
>
>
> For paying options, see
> http://www.xwiki.org/xwiki/bin/view/Main/Support#HProfessionalSupport
>
>
>
> In short, you should contact the company. For XWiki SAS I guess you could
> use: http://www.xwiki.com/en/company/contact-us
>
>
>
> Thanks
>
> -Vincent
>
>
>
>
>
> >
>
> > Keith Davis (214) 906-5183 - I.T. Director
>
> >
>
> > -Original Message-
>
> > From: devs [mailto:devs-boun...@xwiki.org] On Behalf Of Marius 

Re: [xwiki-devs] Nested Pages - Search Links Not Working

[Keith Davis]

That’s easy to check thanks to archives:

http://xwiki.markmail.org/search/?q=from%3Apridedallas.com



Thanks, and I did find that today, but I was still skeptical.



FTR I did answer some of your question(s).



Yes, and you have been very helpful, Vincent, and I was wrong, someone (you) 
did respond once since my comments about the release notes, about xwiki.org 
being offline back in May. However, that is the only reply I've received in 
that time and I've sent a number of emails about issues we were having.



One thing I noted though is that your last email is strangely displayed on the 
list:

* It’s not threaded, see http://xwiki.markmail.org/thread/wo7v736e2suupjor. The 
other mails are in a different thread: 
http://xwiki.markmail.org/thread/ryh3igwjvhjqn6pz

Not sure why that is happening either.


* It’s hard to parse visually since there’s no clear visual separation from the 
original content and the reply (like using “>” for example. See how it’s more 
visible at http://markmail.org/message/zd2mepffue4lbrpb for an example). 
Examples:

** http://markmail.org/message/6l7zzlidbafc43tp

** http://markmail.org/message/wo7v736e2suupjor



It probably doesn’t explain anything but could help make your emails more 
appealing.



Yea, I’ve thought about that, but Outlook doesn’t do that by default. I just 
created a custom style to do that to see if it helps.



Well as Maris said you’re using the community channel, not the one for 
professional services so it’s a bit normal that nobody replied to you when you 
asked  to pay someone ;)



For paying options, see 
http://www.xwiki.org/xwiki/bin/view/Main/Support#HProfessionalSupport



In short, you should contact the company. For XWiki SAS I guess you could use: 
http://www.xwiki.com/en/company/contact-us



Did not know there was a “professional services” channel.



Thanks for all of the input, Vincent.





Keith Davis (214) 906-5183 - I.T. Director





-Original Message-
From: devs [mailto:devs-boun...@xwiki.org] On Behalf Of Vincent Massol
Sent: Monday, September 19, 2016 8:09 AM
To: XWiki Developers
Subject: Re: [xwiki-devs] Nested Pages - Search Links Not Working



Hi Keith,



> On 19 Sep 2016, at 14:47, Keith Davis 
> > wrote:

>

> The main reason I posted to devs is because I have not received one

> single response (until this one), for any issue I've posted in over 6

> months - not one. I was concerned either nobody was getting my

> requests



That’s easy to check thanks to archives:

http://xwiki.markmail.org/search/?q=from%3Apridedallas.com



> or that I everyone was just ignoring me due to my previous comments.



FTR I did answer some of your question(s).



I don’t know why you didn’t get more answers.



One thing I noted though is that your last email is strangely displayed on the 
list:

* It’s not threaded, see http://xwiki.markmail.org/thread/wo7v736e2suupjor. The 
other mails are in a different thread: 
http://xwiki.markmail.org/thread/ryh3igwjvhjqn6pz

* It’s hard to parse visually since there’s no clear visual separation from the 
original content and the reply (like using “>” for example. See how it’s more 
visible at http://markmail.org/message/zd2mepffue4lbrpb for an example). 
Examples:

** http://markmail.org/message/6l7zzlidbafc43tp

** http://markmail.org/message/wo7v736e2suupjor



It probably doesn’t explain anything but could help make your emails more 
appealing.



> I just wanted to make sure that I was actually being received, but I guess I 
> would get about this response if I was.

>

> I realize this is community support, but I've even offered to pay someone for 
> support and got zero takers. We depend on this Wiki as it's the only one out 
> there that really fits our needs. Thanks for responding. I'll wait and see if 
> any responds to my current issue.



Well as Maris said you’re using the community channel, not the one for 
professional services so it’s a bit normal that nobody replied to you when you 
asked  to pay someone ;)



For paying options, see 
http://www.xwiki.org/xwiki/bin/view/Main/Support#HProfessionalSupport



In short, you should contact the company. For XWiki SAS I guess you could use: 
http://www.xwiki.com/en/company/contact-us



Thanks

-Vincent





>

> Keith Davis (214) 906-5183 - I.T. Director

>

> -Original Message-

> From: devs [mailto:devs-boun...@xwiki.org] On Behalf Of Marius Dumitru

> Florea

> Sent: Monday, September 19, 2016 7:06 AM

> To: XWiki Developers

> Subject: Re: [xwiki-devs] Nested Pages - Search Links Not Working

>

> Hi Keith,

>

> I suggest you read again the description of this mailing list from 
> http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists . I think your 
> question is related to the usage of XWiki not to its development. But before 
> you re-post your question to the users mailing list, you should read 
> 

Re: [xwiki-devs] [Proposal] Release Notes Application

[Ecaterina Moraru (Valica)]

I've re-read your answer about "The idea now is more that he release notes
should focus on summarizing the changes rather than documenting them.". In
this case instead of ExtensionFeatureClass, we could have something like
ExtensionFeatureSummaryClass or ExtensionFeatureHighlightClass. My only
point is that I don't understand why we would use a different application,
instead of extending the Repo app and keep all related things together (the
only problem is having too many objects for a particular page).

Thanks,
Caty

On Mon, Sep 19, 2016 at 5:24 PM, Ecaterina Moraru (Valica) <
vali...@gmail.com> wrote:

> If we extend the Repo app and create this ExtensionFeatureClass that
> contains all your XProperties (except Category) than we can include them
> easily in the RN and Documentation.
>
> We kind of have a "practice" to use something like "Since 8.3M2" (example
> in http://extensions.xwiki.org/xwiki/bin/view/Extension/
> Administration+Application) that could be generated from these types of
> objects, using different layouts depending if we are in RN or
> documentation.
>
> I'm stopping :) but the thing is that no matter how we implement the
> application is going to be useful to be able to filter
> features/versions/extension. So I'm excited to see it happen.
>
> Thanks,
> Caty
>
> On Mon, Sep 19, 2016 at 5:02 PM, Ecaterina Moraru (Valica) <
> vali...@gmail.com> wrote:
>
>> Why don't we just improve this class http://extensions.xwiki.org/xw
>> iki/bin/view/ExtensionCode/ExtensionVersionClass ?
>>
>> Maybe the difference is that this is per version and you kind of want per
>> functionality.
>>
>> But the 'Category' is not needed, since we have the extension page name.
>>
>> The idea is that I would really want us to see if we could use this
>> application also in the future, to document things for the extensions
>> pages.
>>
>> Thanks,
>> Caty
>>
>> On Mon, Sep 19, 2016 at 3:13 PM, Ecaterina Moraru (Valica) <
>> vali...@gmail.com> wrote:
>>
>>>
>>>
>>> On Fri, Sep 16, 2016 at 7:18 PM, Vincent Massol 
>>> wrote:
>>>
 Hi devs,

 I’m planning to write a Release Notes Application for xwiki.org. I’d
 like to do something relatively simple in order to have a first working
 version.

 Rationale
 

 * Have nicer looking release notes by defining a structure and a common
 L
 * For users, be able to see all the release notes item from a given
 version to another version and by category

 Idea
 

 Specifically for the “New and Networthy" section have:
 - A visual that looks like this: https://www.jetbrains.com/data
 grip/features/
 - 2 columns layout
 - For each item a screenshot and a summary text
 - (optional) Have a “Learn more” button that goes to the item and
 provides more info (and possibly more screenshots if need be)

 XProperties:
 - Version (in which the item has been added). Static list
 - Category (Help, Color Themes, Solr Search, AWM, etc). Static list
 - Main screenshot
 - Summary text
 - Additional content
 - Target audience (User, Admin, Developer). Static list

 Notes:
 - If no “main screenshot” is provided then the generated report will
 put the item in a Miscellaneous section

 For now I don’t want to handle other metadata for the releases notes,
 i.e. translations, upgrades, backward compat, tested browsers, etc).
 Precisely, I’m planning to write a “New and Networthy” application ATM, not
 a full “Release notes app”.

 The way it could be used is through a {{news/}} macro, e.g.: {{news
 from=“6.4” to=“8.2” [categories=“help,awm,...”]
 [targetAudience=“user,admin”] /}}.

 Usage
 ==

 - There would be a page in the wiki to see the livetable corresponding
 to all the release notes news (the xproperties above)
 - Above this Livetable I imagine a form with several fields:
 — From version,
 — To Version
 — Category (if not empty generate the report only for that category)
 — Target (user, admin, dev). (if not empty only generate the report for
 that target audience)
 — + a “Generate” button to generate a dynamic "News and Networthy”
 report
 - We would also use Tags for each news to categorize it further, e.g.
 “usability”, “performance”, and the LT would display the tag cloud. This
 will allow for example to see all items between such version and such
 version that are related to, say, performance
 - We would still write a Release Notes page for each version but on
 that page, we would use the {{news/}} macro (with from = to = the version
 corresponding to that RN). On that page we would add all the other parts
 that are not in the app yet, i.e. translations, upgrades, backward compat,
 etc
 - When an XWiki developers codes a new feature or improvement or new
 API will use the app to add 

Re: [xwiki-devs] [Proposal] Release Notes Application

[Ecaterina Moraru (Valica)]

If we extend the Repo app and create this ExtensionFeatureClass that
contains all your XProperties (except Category) than we can include them
easily in the RN and Documentation.

We kind of have a "practice" to use something like "Since 8.3M2" (example
in
http://extensions.xwiki.org/xwiki/bin/view/Extension/Administration+Application)
that could be generated from these types of objects, using different
layouts depending if we are in RN or documentation.

I'm stopping :) but the thing is that no matter how we implement the
application is going to be useful to be able to filter
features/versions/extension. So I'm excited to see it happen.

Thanks,
Caty

On Mon, Sep 19, 2016 at 5:02 PM, Ecaterina Moraru (Valica) <
vali...@gmail.com> wrote:

> Why don't we just improve this class http://extensions.xwiki.org/
> xwiki/bin/view/ExtensionCode/ExtensionVersionClass ?
>
> Maybe the difference is that this is per version and you kind of want per
> functionality.
>
> But the 'Category' is not needed, since we have the extension page name.
>
> The idea is that I would really want us to see if we could use this
> application also in the future, to document things for the extensions
> pages.
>
> Thanks,
> Caty
>
> On Mon, Sep 19, 2016 at 3:13 PM, Ecaterina Moraru (Valica) <
> vali...@gmail.com> wrote:
>
>>
>>
>> On Fri, Sep 16, 2016 at 7:18 PM, Vincent Massol 
>> wrote:
>>
>>> Hi devs,
>>>
>>> I’m planning to write a Release Notes Application for xwiki.org. I’d
>>> like to do something relatively simple in order to have a first working
>>> version.
>>>
>>> Rationale
>>> 
>>>
>>> * Have nicer looking release notes by defining a structure and a common
>>> L
>>> * For users, be able to see all the release notes item from a given
>>> version to another version and by category
>>>
>>> Idea
>>> 
>>>
>>> Specifically for the “New and Networthy" section have:
>>> - A visual that looks like this: https://www.jetbrains.com/data
>>> grip/features/
>>> - 2 columns layout
>>> - For each item a screenshot and a summary text
>>> - (optional) Have a “Learn more” button that goes to the item and
>>> provides more info (and possibly more screenshots if need be)
>>>
>>> XProperties:
>>> - Version (in which the item has been added). Static list
>>> - Category (Help, Color Themes, Solr Search, AWM, etc). Static list
>>> - Main screenshot
>>> - Summary text
>>> - Additional content
>>> - Target audience (User, Admin, Developer). Static list
>>>
>>> Notes:
>>> - If no “main screenshot” is provided then the generated report will put
>>> the item in a Miscellaneous section
>>>
>>> For now I don’t want to handle other metadata for the releases notes,
>>> i.e. translations, upgrades, backward compat, tested browsers, etc).
>>> Precisely, I’m planning to write a “New and Networthy” application ATM, not
>>> a full “Release notes app”.
>>>
>>> The way it could be used is through a {{news/}} macro, e.g.: {{news
>>> from=“6.4” to=“8.2” [categories=“help,awm,...”]
>>> [targetAudience=“user,admin”] /}}.
>>>
>>> Usage
>>> ==
>>>
>>> - There would be a page in the wiki to see the livetable corresponding
>>> to all the release notes news (the xproperties above)
>>> - Above this Livetable I imagine a form with several fields:
>>> — From version,
>>> — To Version
>>> — Category (if not empty generate the report only for that category)
>>> — Target (user, admin, dev). (if not empty only generate the report for
>>> that target audience)
>>> — + a “Generate” button to generate a dynamic "News and Networthy” report
>>> - We would also use Tags for each news to categorize it further, e.g.
>>> “usability”, “performance”, and the LT would display the tag cloud. This
>>> will allow for example to see all items between such version and such
>>> version that are related to, say, performance
>>> - We would still write a Release Notes page for each version but on that
>>> page, we would use the {{news/}} macro (with from = to = the version
>>> corresponding to that RN). On that page we would add all the other parts
>>> that are not in the app yet, i.e. translations, upgrades, backward compat,
>>> etc
>>> - When an XWiki developers codes a new feature or improvement or new API
>>> will use the app to add it.
>>>
>>> Future
>>> ==
>>>
>>> * Add a different release notes app to include the other metadata
>>> * We could almost imagine using this “New and networthy” app to provide
>>> reference documentation for our features… :) (along with automatic
>>> “since”). That’s probably too science-fiction and I’m sure there are lots
>>> of gotchas but just mentioning it here to make us dream a bit...
>>>
>>
>> I don't see how what you are proposing is any different from the Features
>> documentation. Maybe this is the way to finally merge the documentation
>> instead of having it spread in e.x.o and RNs. I guess the only difference
>> is where we store the objects/pages. The release notes presents information
>> for a particular version, 

Re: [xwiki-devs] [Proposal] Release Notes Application

[Ecaterina Moraru (Valica)]

Why don't we just improve this class
http://extensions.xwiki.org/xwiki/bin/view/ExtensionCode/ExtensionVersionClass
?

Maybe the difference is that this is per version and you kind of want per
functionality.

But the 'Category' is not needed, since we have the extension page name.

The idea is that I would really want us to see if we could use this
application also in the future, to document things for the extensions
pages.

Thanks,
Caty

On Mon, Sep 19, 2016 at 3:13 PM, Ecaterina Moraru (Valica) <
vali...@gmail.com> wrote:

>
>
> On Fri, Sep 16, 2016 at 7:18 PM, Vincent Massol 
> wrote:
>
>> Hi devs,
>>
>> I’m planning to write a Release Notes Application for xwiki.org. I’d
>> like to do something relatively simple in order to have a first working
>> version.
>>
>> Rationale
>> 
>>
>> * Have nicer looking release notes by defining a structure and a common
>> L
>> * For users, be able to see all the release notes item from a given
>> version to another version and by category
>>
>> Idea
>> 
>>
>> Specifically for the “New and Networthy" section have:
>> - A visual that looks like this: https://www.jetbrains.com/data
>> grip/features/
>> - 2 columns layout
>> - For each item a screenshot and a summary text
>> - (optional) Have a “Learn more” button that goes to the item and
>> provides more info (and possibly more screenshots if need be)
>>
>> XProperties:
>> - Version (in which the item has been added). Static list
>> - Category (Help, Color Themes, Solr Search, AWM, etc). Static list
>> - Main screenshot
>> - Summary text
>> - Additional content
>> - Target audience (User, Admin, Developer). Static list
>>
>> Notes:
>> - If no “main screenshot” is provided then the generated report will put
>> the item in a Miscellaneous section
>>
>> For now I don’t want to handle other metadata for the releases notes,
>> i.e. translations, upgrades, backward compat, tested browsers, etc).
>> Precisely, I’m planning to write a “New and Networthy” application ATM, not
>> a full “Release notes app”.
>>
>> The way it could be used is through a {{news/}} macro, e.g.: {{news
>> from=“6.4” to=“8.2” [categories=“help,awm,...”]
>> [targetAudience=“user,admin”] /}}.
>>
>> Usage
>> ==
>>
>> - There would be a page in the wiki to see the livetable corresponding to
>> all the release notes news (the xproperties above)
>> - Above this Livetable I imagine a form with several fields:
>> — From version,
>> — To Version
>> — Category (if not empty generate the report only for that category)
>> — Target (user, admin, dev). (if not empty only generate the report for
>> that target audience)
>> — + a “Generate” button to generate a dynamic "News and Networthy” report
>> - We would also use Tags for each news to categorize it further, e.g.
>> “usability”, “performance”, and the LT would display the tag cloud. This
>> will allow for example to see all items between such version and such
>> version that are related to, say, performance
>> - We would still write a Release Notes page for each version but on that
>> page, we would use the {{news/}} macro (with from = to = the version
>> corresponding to that RN). On that page we would add all the other parts
>> that are not in the app yet, i.e. translations, upgrades, backward compat,
>> etc
>> - When an XWiki developers codes a new feature or improvement or new API
>> will use the app to add it.
>>
>> Future
>> ==
>>
>> * Add a different release notes app to include the other metadata
>> * We could almost imagine using this “New and networthy” app to provide
>> reference documentation for our features… :) (along with automatic
>> “since”). That’s probably too science-fiction and I’m sure there are lots
>> of gotchas but just mentioning it here to make us dream a bit...
>>
>
> I don't see how what you are proposing is any different from the Features
> documentation. Maybe this is the way to finally merge the documentation
> instead of having it spread in e.x.o and RNs. I guess the only difference
> is where we store the objects/pages. The release notes presents information
> for a particular version, while feature documentation presents information
> for a particular feature/category. We could use the same objects, with
> different parameters to display both RN and Documentation.
>
> Regarding the inspiration for your proposal, I find their release notes to
> be more interesting https://www.jetbrains.com/datagrip/whatsnew/#language-
> injections
> For example they provide the "categories navigation" at the top and also
> they group multiple functionalities for a particular category together,
> using subheaders.
>
> I like what you did with the prototype. Unfortunately it's a bit hard to
> read and focus on reading the content: mostly because it's a bit crowded
> (with the 2/3 columns layout) and the dark gallery background is very
> distracting. But the styling can be fixed and the most important part are
> the app and metadata.
>
> The idea to present as 

Re: [xwiki-devs] Release notes strategy for included contrib extensions

[Ecaterina Moraru (Valica)]

We could have an "Extensions" section in the RN of XE where we could
display noticeable functionalities. So that's your 1) variant.

My problem is that we have this discrepancy between RN and Documentation.
So this means we would duplicate content to RN and Documentation, instead
of reusing it. Usually instead of duplicating it, we just put it in one
place and link from the other. Maybe the "News and Worthy" application
could improve this. Have some ReleaseNotes objects per version that could
be integrated inside XE RN and Extensions documentation, and use them from
the XE RN.

Thanks,
Caty

On Mon, Sep 19, 2016 at 4:51 PM, Marius Dumitru Florea <
mariusdumitru.flo...@xwiki.com> wrote:

> +1 for 1)
>
> Thanks,
> Marius
>
> On Tue, Sep 13, 2016 at 7:23 PM, Vincent Massol 
> wrote:
>
> > Hi devs,
> >
> > We now include a few contrib apps in XE. However, when someone checks the
> > RN for XE, for example http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/
> > ReleaseNotesXWiki83M2 all they see is this:
> >
> > “The following dependencies have been upgraded:
> > * Tour Application 1.0.4”
> >
> > It doesn’t say if there are any substantial things added those deps.
> >
> > I can think of 2 solutions:
> >
> > 1) When something is noticeable, add it to the RN of XE. So for example
> if
> > CKEditor extension adds something new, users checking the RN of XE can
> see
> > it immediately.
> >
> > 2) Link to the RN of the extension. However RN of extensions on e.x.o are
> > not nice. They’re just lists of JIRA issues. So for this solution to be a
> > bit satisfactory we would need to improve the RN of extensions, starting
> > with those we bundle in XE. Another possibility is to say that for
> > Recommended Extensions we pay an extra care to write nice Release Notes.
> > But that’s harder to enforce and ensure.
> >
> > Option 1) is my preference.
> >
> > WDYT?
> >
> > Thanks
> > -Vincent
> >
> > ___
> > devs mailing list
> > devs@xwiki.org
> > http://lists.xwiki.org/mailman/listinfo/devs
> >
> ___
> devs mailing list
> devs@xwiki.org
> http://lists.xwiki.org/mailman/listinfo/devs
>
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] Release notes strategy for included contrib extensions

[Marius Dumitru Florea]

+1 for 1)

Thanks,
Marius

On Tue, Sep 13, 2016 at 7:23 PM, Vincent Massol  wrote:

> Hi devs,
>
> We now include a few contrib apps in XE. However, when someone checks the
> RN for XE, for example http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/
> ReleaseNotesXWiki83M2 all they see is this:
>
> “The following dependencies have been upgraded:
> * Tour Application 1.0.4”
>
> It doesn’t say if there are any substantial things added those deps.
>
> I can think of 2 solutions:
>
> 1) When something is noticeable, add it to the RN of XE. So for example if
> CKEditor extension adds something new, users checking the RN of XE can see
> it immediately.
>
> 2) Link to the RN of the extension. However RN of extensions on e.x.o are
> not nice. They’re just lists of JIRA issues. So for this solution to be a
> bit satisfactory we would need to improve the RN of extensions, starting
> with those we bundle in XE. Another possibility is to say that for
> Recommended Extensions we pay an extra care to write nice Release Notes.
> But that’s harder to enforce and ensure.
>
> Option 1) is my preference.
>
> WDYT?
>
> Thanks
> -Vincent
>
> ___
> devs mailing list
> devs@xwiki.org
> http://lists.xwiki.org/mailman/listinfo/devs
>
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] Nested Pages - Search Links Not Working

[Vincent Massol]

Hi Keith,

> On 19 Sep 2016, at 14:47, Keith Davis  wrote:
> 
> The main reason I posted to devs is because I have not received one single 
> response (until this one), for any issue I've posted in over 6 months - not 
> one. I was concerned either nobody was getting my requests

That’s easy to check thanks to archives:
http://xwiki.markmail.org/search/?q=from%3Apridedallas.com

> or that I everyone was just ignoring me due to my previous comments.

FTR I did answer some of your question(s).

I don’t know why you didn’t get more answers. 

One thing I noted though is that your last email is strangely displayed on the 
list:
* It’s not threaded, see http://xwiki.markmail.org/thread/wo7v736e2suupjor. The 
other mails are in a different thread: 
http://xwiki.markmail.org/thread/ryh3igwjvhjqn6pz
* It’s hard to parse visually since there’s no clear visual separation from the 
original content and the reply (like using “>” for example. See how it’s more 
visible at http://markmail.org/message/zd2mepffue4lbrpb for an example). 
Examples:
** http://markmail.org/message/6l7zzlidbafc43tp
** http://markmail.org/message/wo7v736e2suupjor

It probably doesn’t explain anything but could help make your emails more 
appealing.

> I just wanted to make sure that I was actually being received, but I guess I 
> would get about this response if I was.
> 
> I realize this is community support, but I've even offered to pay someone for 
> support and got zero takers. We depend on this Wiki as it's the only one out 
> there that really fits our needs. Thanks for responding. I'll wait and see if 
> any responds to my current issue.

Well as Maris said you’re using the community channel, not the one for 
professional services so it’s a bit normal that nobody replied to you when you 
asked  to pay someone ;)

For paying options, see 
http://www.xwiki.org/xwiki/bin/view/Main/Support#HProfessionalSupport

In short, you should contact the company. For XWiki SAS I guess you could use: 
http://www.xwiki.com/en/company/contact-us

Thanks
-Vincent


> 
> Keith Davis (214) 906-5183 - I.T. Director
> 
> -Original Message-
> From: devs [mailto:devs-boun...@xwiki.org] On Behalf Of Marius Dumitru Florea
> Sent: Monday, September 19, 2016 7:06 AM
> To: XWiki Developers
> Subject: Re: [xwiki-devs] Nested Pages - Search Links Not Working
> 
> Hi Keith,
> 
> I suggest you read again the description of this mailing list from 
> http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists . I think your 
> question is related to the usage of XWiki not to its development. But before 
> you re-post your question to the users mailing list, you should read 
> http://www.xwiki.org/xwiki/bin/view/Main/Support . You'll see that the 
> community support does not guarantee a response time and it works on a 
> give-give basis. 3 days is not a long time, especially since there was a 
> weekend in between.
> 
> I hope you understand,
> Marius
> 
> On Mon, Sep 19, 2016 at 2:22 PM, Keith Davis 
> wrote:
> 
>> It's very hard to manage this application with zero support. Am I 
>> blacklisted or what? I haven't received input on a single support 
>> issue since I complained about the release notes issue (which 
>> strangely enough seems to be being worked on now).
>> 
>> Keith Davis (214) 906-5183 - I.T. Director
>> 
>> From: Keith Davis
>> Sent: Friday, September 16, 2016 11:54 AM
>> To: 'devs@xwiki.org'
>> Subject: Nested Pages - Search Links Not Working
>> 
>> So we are now starting to change all of the our pages to Nested. When 
>> linking to Nested pages in the page themselves, the links appear like 
>> this in the WYSIWYG editor:
>> 
>> [[Tickets>>Main.Intranet.Tickets]]
>> 
>> but when saved are converted to this:
>> 
>> Tickets
>> 
>> However, Search results are broken. They appear like this:
>> 
>> [cid:image005.jpg@01D20F61.C86FF330]
>> 
>> Those do not work as the link Main.Intranet.Tickets takes me to this page:
>> 
>> [cid:image006.jpg@01D20F61.C86FF330]
>> 
>> I've tried re-indexing, but that does not help.
>> 
>> Keith Davis - MCSA, ZCE
>> P.R.I.D.E. - I.T. Director / Senior Developer 
>> www.pridedallas.com
>> Mobile (214) 906-5183
>> 

___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] Nested Pages - Search Links Not Working

[Keith Davis]

The main reason I posted to devs is because I have not received one single 
response (until this one), for any issue I've posted in over 6 months - not 
one. I was concerned either nobody was getting my requests or that I everyone 
was just ignoring me due to my previous comments.

I just wanted to make sure that I was actually being received, but I guess I 
would get about this response if I was.

I realize this is community support, but I've even offered to pay someone for 
support and got zero takers. We depend on this Wiki as it's the only one out 
there that really fits our needs. Thanks for responding. I'll wait and see if 
any responds to my current issue.

Keith Davis (214) 906-5183 - I.T. Director

-Original Message-
From: devs [mailto:devs-boun...@xwiki.org] On Behalf Of Marius Dumitru Florea
Sent: Monday, September 19, 2016 7:06 AM
To: XWiki Developers
Subject: Re: [xwiki-devs] Nested Pages - Search Links Not Working

Hi Keith,

I suggest you read again the description of this mailing list from 
http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists . I think your 
question is related to the usage of XWiki not to its development. But before 
you re-post your question to the users mailing list, you should read 
http://www.xwiki.org/xwiki/bin/view/Main/Support . You'll see that the 
community support does not guarantee a response time and it works on a 
give-give basis. 3 days is not a long time, especially since there was a 
weekend in between.

I hope you understand,
Marius

On Mon, Sep 19, 2016 at 2:22 PM, Keith Davis 
wrote:

> It's very hard to manage this application with zero support. Am I 
> blacklisted or what? I haven't received input on a single support 
> issue since I complained about the release notes issue (which 
> strangely enough seems to be being worked on now).
>
> Keith Davis (214) 906-5183 - I.T. Director
>
> From: Keith Davis
> Sent: Friday, September 16, 2016 11:54 AM
> To: 'devs@xwiki.org'
> Subject: Nested Pages - Search Links Not Working
>
> So we are now starting to change all of the our pages to Nested. When 
> linking to Nested pages in the page themselves, the links appear like 
> this in the WYSIWYG editor:
>
> [[Tickets>>Main.Intranet.Tickets]]
>
> but when saved are converted to this:
>
> Tickets
>
> However, Search results are broken. They appear like this:
>
> [cid:image005.jpg@01D20F61.C86FF330]
>
> Those do not work as the link Main.Intranet.Tickets takes me to this page:
>
> [cid:image006.jpg@01D20F61.C86FF330]
>
> I've tried re-indexing, but that does not help.
>
> Keith Davis - MCSA, ZCE
> P.R.I.D.E. - I.T. Director / Senior Developer 
> www.pridedallas.com
> Mobile (214) 906-5183
>
>
> ___
> devs mailing list
> devs@xwiki.org
> http://lists.xwiki.org/mailman/listinfo/devs
>
>
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] [Proposal] Release Notes Application

[Ecaterina Moraru (Valica)]

On Fri, Sep 16, 2016 at 7:18 PM, Vincent Massol  wrote:

> Hi devs,
>
> I’m planning to write a Release Notes Application for xwiki.org. I’d like
> to do something relatively simple in order to have a first working version.
>
> Rationale
> 
>
> * Have nicer looking release notes by defining a structure and a common L
> * For users, be able to see all the release notes item from a given
> version to another version and by category
>
> Idea
> 
>
> Specifically for the “New and Networthy" section have:
> - A visual that looks like this: https://www.jetbrains.com/
> datagrip/features/
> - 2 columns layout
> - For each item a screenshot and a summary text
> - (optional) Have a “Learn more” button that goes to the item and provides
> more info (and possibly more screenshots if need be)
>
> XProperties:
> - Version (in which the item has been added). Static list
> - Category (Help, Color Themes, Solr Search, AWM, etc). Static list
> - Main screenshot
> - Summary text
> - Additional content
> - Target audience (User, Admin, Developer). Static list
>
> Notes:
> - If no “main screenshot” is provided then the generated report will put
> the item in a Miscellaneous section
>
> For now I don’t want to handle other metadata for the releases notes, i.e.
> translations, upgrades, backward compat, tested browsers, etc). Precisely,
> I’m planning to write a “New and Networthy” application ATM, not a full
> “Release notes app”.
>
> The way it could be used is through a {{news/}} macro, e.g.: {{news
> from=“6.4” to=“8.2” [categories=“help,awm,...”]
> [targetAudience=“user,admin”] /}}.
>
> Usage
> ==
>
> - There would be a page in the wiki to see the livetable corresponding to
> all the release notes news (the xproperties above)
> - Above this Livetable I imagine a form with several fields:
> — From version,
> — To Version
> — Category (if not empty generate the report only for that category)
> — Target (user, admin, dev). (if not empty only generate the report for
> that target audience)
> — + a “Generate” button to generate a dynamic "News and Networthy” report
> - We would also use Tags for each news to categorize it further, e.g.
> “usability”, “performance”, and the LT would display the tag cloud. This
> will allow for example to see all items between such version and such
> version that are related to, say, performance
> - We would still write a Release Notes page for each version but on that
> page, we would use the {{news/}} macro (with from = to = the version
> corresponding to that RN). On that page we would add all the other parts
> that are not in the app yet, i.e. translations, upgrades, backward compat,
> etc
> - When an XWiki developers codes a new feature or improvement or new API
> will use the app to add it.
>
> Future
> ==
>
> * Add a different release notes app to include the other metadata
> * We could almost imagine using this “New and networthy” app to provide
> reference documentation for our features… :) (along with automatic
> “since”). That’s probably too science-fiction and I’m sure there are lots
> of gotchas but just mentioning it here to make us dream a bit...
>

I don't see how what you are proposing is any different from the Features
documentation. Maybe this is the way to finally merge the documentation
instead of having it spread in e.x.o and RNs. I guess the only difference
is where we store the objects/pages. The release notes presents information
for a particular version, while feature documentation presents information
for a particular feature/category. We could use the same objects, with
different parameters to display both RN and Documentation.

Regarding the inspiration for your proposal, I find their release notes to
be more interesting
https://www.jetbrains.com/datagrip/whatsnew/#language-injections
For example they provide the "categories navigation" at the top and also
they group multiple functionalities for a particular category together,
using subheaders.

I like what you did with the prototype. Unfortunately it's a bit hard to
read and focus on reading the content: mostly because it's a bit crowded
(with the 2/3 columns layout) and the dark gallery background is very
distracting. But the styling can be fixed and the most important part are
the app and metadata.

The idea to present as note in the Miscellaneous section if it doesn't have
a screenshot is interesting. But we could also consider that we might want
to have some small category summaries, where we list just the text, without
any screenshots. Or that we might want to showcase just the screenshots.
But this are just small observations and can be improved with display
parameters.

Regarding importance, we need to be careful not to duplicate many things
that we have in the jira issue. A wild idea would be to assign per
functionality a jira issue and the app could extract metadata from there
(the importance, the category, the version, etc.) But that's SF :)

Nice work Vincent.

Re: [xwiki-devs] [Proposal] Release Notes Application

[Vincent Massol]

Hi Marius;

> On 19 Sep 2016, at 13:46, Marius Dumitru Florea 
>  wrote:
> 
> On Sat, Sep 17, 2016 at 6:29 PM, Vincent Massol  wrote:
> 
>> Hi again,
>> 
>> Done more coding (in front of the TV watching the Tennis David cup :
>> France vs Croatia ;))...
>> 
>> I’ve now completely rewritten the 8.3M1 release notes using the release
>> notes app:
>> https://www.evernote.com/l/AHc8Tp-XK6VMkY8ZL0YnNuEg7XLUavZliKM
>> 
>> FTR changes I’ve brought:
>> * In the end, "When the target audience is “developer” the screenshot is
>> replaced by an example.” was not a good idea and I’ve dropped it.
>> * For the developers section, I’ve used a single column view. FTR here’s
>> the wiki syntax for the New and Networthy part:
>> 
>> "
>> = New and Noteworthy (since XWiki 8.2) =
>> 
>> [[Full list of issues fixed and Dashboard for 8.3>>http://jira.xwiki.org/
>> secure/Dashboard.jspa?selectPageId=13629]].
>> 
>> == For Users ==
>> 
>> {{news columns="3" audience="user"/}}
>> 
>> == For Admins ==
>> 
>> {{news columns="3" audience="administrator"/}}
>> 
>> == For Developers ==
>> 
>> {{news columns="1" audience="developer"/}}
>> “
>> 
>> 
> 
>> I’m quite happy about the result. Do you like it too?
>> 
> 
> The release page layout should be responsive or at least it should look
> nice on a small screen. Hard-coding the 3-column layout is not nice.

I’m using bootstrap grids. We can tune that but it should already be responsive.

> The black background color of the gallery macro works when you have a
> single gallery, but in your case I feel it distracts the view.

The gallery should be a lot more configurable:
* Ability to set maxWdith/maxHeight
* Ability to set the background color
* Ability to not display navigation arrows and image number when there’s only 1 
image

> I assume you group the new features by category,

I don’t yet (but would be a good idea). I’m grouping by Audience only (user, 
admin, dev).

> but what about the order
> between the categories and inside each category. We want to push the most
> important features/categories first.

It’s a complex topic and I’m not sure sure we need it. The column layout I’ve 
shown allows to display a lot more changes than before. It’s also a change of 
spirit. The idea now is more that he release notes should focus on summarizing 
the changes rather than documenting them. It happens that we put too much in 
the release notes when the changes should be documented in the reference 
documentation. I think we only need a summary and then point to the reference 
documentation for more details.

What I mean is that I feel that the order is less important if the user can see 
at a glance all the changes in a more structured and visible way.

In addition the importance is relative. An item can be very important for a 
given release note but less important when put next to other changes from 
previous release notes. Said differently, if I ask for all changes from XWiki 
7.0 to XWiki 7.4, the importance order will definitely be different from the 
order for, say, XWiki 7.2.

So I’d say, let’s try without order first and see if we really need to define 
an order in the structure.

Now what we could do that would make sense I think is a global indication of 
the level of importance with 2 levels:
* High importance (new features, large improvements)
* Small importance (cosmetic changes, small improvements)

> Also, when there are many (small) new features it may be good to visually
> mark their category (or separate each category, like the headings we have
> know) because someone reading the release notes may be interested only in a
> specific topic (e.g. Solr changes).

That’s the point, the app allows you to generate a report of whatever you’re 
interested in. I dissociate 2 things:
* The Release Notes. Which is fixed and contains changes + other information 
(backward compat, translations, etc)
* The Changes App, which allows to generate all the changes from version N to 
version P, for category C, for target audience T. So you can ask: show me all 
changes in XWiki 8.3M1 related to Solr. In the future I’d like to add support 
for asking for specific tags too to be able to ask for all performance-related 
changes too. Note that the Category data could also be implemented in the same 
way I guess but FTM it’s implemented as an xproperty.

What we could do is display some tags displayed as labels under the change 
titles.

> Plus, it may be hard to understand from
> the title that a specific new feature is related to a specific topic
> (category), especially when you scan the release notes quickly in search
> for something (the Table of Contents is useful for this).
> 
> +1 for adding more structure to the release notes.

Thanks for the feedback. There are plenty of things to do and tune. I want to 
get started.

Note: I also want to be careful about not adding too much structure since too 
much metadata means you need to fill it and 

Re: [xwiki-devs] Nested Pages - Search Links Not Working

[Marius Dumitru Florea]

Hi Keith,

I suggest you read again the description of this mailing list from
http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists . I think your
question is related to the usage of XWiki not to its development. But
before you re-post your question to the users mailing list, you should read
http://www.xwiki.org/xwiki/bin/view/Main/Support . You'll see that the
community support does not guarantee a response time and it works on a
give-give basis. 3 days is not a long time, especially since there was a
weekend in between.

I hope you understand,
Marius

On Mon, Sep 19, 2016 at 2:22 PM, Keith Davis 
wrote:

> It's very hard to manage this application with zero support. Am I
> blacklisted or what? I haven't received input on a single support issue
> since I complained about the release notes issue (which strangely enough
> seems to be being worked on now).
>
> Keith Davis (214) 906-5183 - I.T. Director
>
> From: Keith Davis
> Sent: Friday, September 16, 2016 11:54 AM
> To: 'devs@xwiki.org'
> Subject: Nested Pages - Search Links Not Working
>
> So we are now starting to change all of the our pages to Nested. When
> linking to Nested pages in the page themselves, the links appear like this
> in the WYSIWYG editor:
>
> [[Tickets>>Main.Intranet.Tickets]]
>
> but when saved are converted to this:
>
> Tickets
>
> However, Search results are broken. They appear like this:
>
> [cid:image005.jpg@01D20F61.C86FF330]
>
> Those do not work as the link Main.Intranet.Tickets takes me to this page:
>
> [cid:image006.jpg@01D20F61.C86FF330]
>
> I've tried re-indexing, but that does not help.
>
> Keith Davis - MCSA, ZCE
> P.R.I.D.E. - I.T. Director / Senior Developer
> www.pridedallas.com
> Mobile (214) 906-5183
>
>
> ___
> devs mailing list
> devs@xwiki.org
> http://lists.xwiki.org/mailman/listinfo/devs
>
>
___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] [Proposal] Release Notes Application

[Marius Dumitru Florea]

On Sat, Sep 17, 2016 at 6:29 PM, Vincent Massol  wrote:

> Hi again,
>
> Done more coding (in front of the TV watching the Tennis David cup :
> France vs Croatia ;))...
>
> I’ve now completely rewritten the 8.3M1 release notes using the release
> notes app:
> https://www.evernote.com/l/AHc8Tp-XK6VMkY8ZL0YnNuEg7XLUavZliKM
>
> FTR changes I’ve brought:
> * In the end, "When the target audience is “developer” the screenshot is
> replaced by an example.” was not a good idea and I’ve dropped it.
> * For the developers section, I’ve used a single column view. FTR here’s
> the wiki syntax for the New and Networthy part:
>
> "
> = New and Noteworthy (since XWiki 8.2) =
>
> [[Full list of issues fixed and Dashboard for 8.3>>http://jira.xwiki.org/
> secure/Dashboard.jspa?selectPageId=13629]].
>
> == For Users ==
>
> {{news columns="3" audience="user"/}}
>
> == For Admins ==
>
> {{news columns="3" audience="administrator"/}}
>
> == For Developers ==
>
> {{news columns="1" audience="developer"/}}
> “
>
>

> I’m quite happy about the result. Do you like it too?
>

The release page layout should be responsive or at least it should look
nice on a small screen. Hard-coding the 3-column layout is not nice.

The black background color of the gallery macro works when you have a
single gallery, but in your case I feel it distracts the view.

I assume you group the new features by category, but what about the order
between the categories and inside each category. We want to push the most
important features/categories first.

Also, when there are many (small) new features it may be good to visually
mark their category (or separate each category, like the headings we have
know) because someone reading the release notes may be interested only in a
specific topic (e.g. Solr changes). Plus, it may be hard to understand from
the title that a specific new feature is related to a specific topic
(category), especially when you scan the release notes quickly in search
for something (the Table of Contents is useful for this).

+1 for adding more structure to the release notes.

Thanks,
Marius


>
> Next step: Provide a UI for adding a release notes news (right now I’ve
> used the object editor to write the RN for 8.3M1).
>
> Thanks
> -Vincent
>
>
> > On 17 Sep 2016, at 12:27, Vincent Massol  wrote:
> >
> > I’ve done a quick POC locally, if you’re curious:
> >
> > * 3 columns view (using {{news columns=“3”/}}:
> > https://www.evernote.com/l/AHcrwTDtWzBL7JaGLsTvj3NcP95dEYwraOc
> >
> > * 2 columns view (using {{news columns=“2"/}}:
> > https://www.evernote.com/l/AHche7VWkv1KgLZPkWqbVv_ZGn728y-tAzw
> >
> > * Livetable view of data:
> > https://www.evernote.com/l/AHcItOb57M9AMIaU6HXBTO04c3o91dVKck4
> >
> > Note1: I’ve added a title xproperty too.
> > Note2: I’ve tweaked a bit the CSS of the galley macro but I could commit
> this (see http://extensions.xwiki.org/xwiki/bin/view/Extension/
> Gallery+Macro?viewer=comments#xwikicomment_6). I’ll also need to talk to
> marius about the 128px padding for left/right arrows (which I’ve reduced to
> 45px for the screenshots above).
> >
> > Thanks
> > -Vincent
> >
> >> On 16 Sep 2016, at 18:18, Vincent Massol  wrote:
> >>
> >> Hi devs,
> >>
> >> I’m planning to write a Release Notes Application for xwiki.org. I’d
> like to do something relatively simple in order to have a first working
> version.
> >>
> >> Rationale
> >> 
> >>
> >> * Have nicer looking release notes by defining a structure and a common
> L
> >> * For users, be able to see all the release notes item from a given
> version to another version and by category
> >>
> >> Idea
> >> 
> >>
> >> Specifically for the “New and Networthy" section have:
> >> - A visual that looks like this: https://www.jetbrains.com/
> datagrip/features/
> >> - 2 columns layout
> >> - For each item a screenshot and a summary text
> >> - (optional) Have a “Learn more” button that goes to the item and
> provides more info (and possibly more screenshots if need be)
> >>
> >> XProperties:
> >> - Version (in which the item has been added). Static list
> >> - Category (Help, Color Themes, Solr Search, AWM, etc). Static list
> >> - Main screenshot
> >> - Summary text
> >> - Additional content
> >> - Target audience (User, Admin, Developer). Static list
> >>
> >> Notes:
> >> - If no “main screenshot” is provided then the generated report will
> put the item in a Miscellaneous section
> >>
> >> For now I don’t want to handle other metadata for the releases notes,
> i.e. translations, upgrades, backward compat, tested browsers, etc).
> Precisely, I’m planning to write a “New and Networthy” application ATM, not
> a full “Release notes app”.
> >>
> >> The way it could be used is through a {{news/}} macro, e.g.: {{news
> from=“6.4” to=“8.2” [categories=“help,awm,...”]
> [targetAudience=“user,admin”] /}}.
> >>
> >> Usage
> >> ==
> >>
> >> - There would be a page in the wiki to see the livetable 

Re: [xwiki-devs] Nested Pages - Search Links Not Working

[Keith Davis]

It's very hard to manage this application with zero support. Am I blacklisted 
or what? I haven't received input on a single support issue since I complained 
about the release notes issue (which strangely enough seems to be being worked 
on now).

Keith Davis (214) 906-5183 - I.T. Director

From: Keith Davis
Sent: Friday, September 16, 2016 11:54 AM
To: 'devs@xwiki.org'
Subject: Nested Pages - Search Links Not Working

So we are now starting to change all of the our pages to Nested. When linking 
to Nested pages in the page themselves, the links appear like this in the 
WYSIWYG editor:

[[Tickets>>Main.Intranet.Tickets]]

but when saved are converted to this:

Tickets

However, Search results are broken. They appear like this:

[cid:image005.jpg@01D20F61.C86FF330]

Those do not work as the link Main.Intranet.Tickets takes me to this page:

[cid:image006.jpg@01D20F61.C86FF330]

I've tried re-indexing, but that does not help.

Keith Davis - MCSA, ZCE
P.R.I.D.E. - I.T. Director / Senior Developer
www.pridedallas.com
Mobile (214) 906-5183

___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs

Re: [xwiki-devs] [Proposal] Release Notes Application

[Benjamin Lanciaux]

Hello Vincent,

I'm +1 with your proposal. It will ease the comparisons of the different
versions.
It also goes beyond the simple wiki page by adding some structure to it.
This is what XWiki is good at after all ;)

Thanks,

Benjamin



2016-09-17 17:38 GMT+02:00 Vincent Massol :

> If you wish to compare with the current RN:
> http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWiki83M1
>
> I personally don’t find it worse. It actually looks even a bit better IMO.
>
> But the pros are not really for this. It’s that now you can do lots of
> reports:
> * See all release notes news for all versions from N to P
> * And only for user-related features
> * Or only for a given module/application. For ex: show me all the changes
> related to SOLR from XWiki 6.1 to XWiki 8.2.
>
> Thanks
> -Vincent
>
> > On 17 Sep 2016, at 17:29, Vincent Massol  wrote:
> >
> > Hi again,
> >
> > Done more coding (in front of the TV watching the Tennis David cup :
> France vs Croatia ;))...
> >
> > I’ve now completely rewritten the 8.3M1 release notes using the release
> notes app:
> > https://www.evernote.com/l/AHc8Tp-XK6VMkY8ZL0YnNuEg7XLUavZliKM
> >
> > FTR changes I’ve brought:
> > * In the end, "When the target audience is “developer” the screenshot is
> replaced by an example.” was not a good idea and I’ve dropped it.
> > * For the developers section, I’ve used a single column view. FTR here’s
> the wiki syntax for the New and Networthy part:
> >
> > "
> > = New and Noteworthy (since XWiki 8.2) =
> >
> > [[Full list of issues fixed and Dashboard for 8.3>>
> http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13629]].
> >
> > == For Users ==
> >
> > {{news columns="3" audience="user"/}}
> >
> > == For Admins ==
> >
> > {{news columns="3" audience="administrator"/}}
> >
> > == For Developers ==
> >
> > {{news columns="1" audience="developer"/}}
> > “
> >
> > I’m quite happy about the result. Do you like it too?
> >
> > Next step: Provide a UI for adding a release notes news (right now I’ve
> used the object editor to write the RN for 8.3M1).
> >
> > Thanks
> > -Vincent
> >
> >
> >> On 17 Sep 2016, at 12:27, Vincent Massol  wrote:
> >>
> >> I’ve done a quick POC locally, if you’re curious:
> >>
> >> * 3 columns view (using {{news columns=“3”/}}:
> >> https://www.evernote.com/l/AHcrwTDtWzBL7JaGLsTvj3NcP95dEYwraOc
> >>
> >> * 2 columns view (using {{news columns=“2"/}}:
> >> https://www.evernote.com/l/AHche7VWkv1KgLZPkWqbVv_ZGn728y-tAzw
> >>
> >> * Livetable view of data:
> >> https://www.evernote.com/l/AHcItOb57M9AMIaU6HXBTO04c3o91dVKck4
> >>
> >> Note1: I’ve added a title xproperty too.
> >> Note2: I’ve tweaked a bit the CSS of the galley macro but I could
> commit this (see http://extensions.xwiki.org/xwiki/bin/view/Extension/
> Gallery+Macro?viewer=comments#xwikicomment_6). I’ll also need to talk to
> marius about the 128px padding for left/right arrows (which I’ve reduced to
> 45px for the screenshots above).
> >>
> >> Thanks
> >> -Vincent
> >>
> >>> On 16 Sep 2016, at 18:18, Vincent Massol  wrote:
> >>>
> >>> Hi devs,
> >>>
> >>> I’m planning to write a Release Notes Application for xwiki.org. I’d
> like to do something relatively simple in order to have a first working
> version.
> >>>
> >>> Rationale
> >>> 
> >>>
> >>> * Have nicer looking release notes by defining a structure and a
> common L
> >>> * For users, be able to see all the release notes item from a given
> version to another version and by category
> >>>
> >>> Idea
> >>> 
> >>>
> >>> Specifically for the “New and Networthy" section have:
> >>> - A visual that looks like this: https://www.jetbrains.com/
> datagrip/features/
> >>> - 2 columns layout
> >>> - For each item a screenshot and a summary text
> >>> - (optional) Have a “Learn more” button that goes to the item and
> provides more info (and possibly more screenshots if need be)
> >>>
> >>> XProperties:
> >>> - Version (in which the item has been added). Static list
> >>> - Category (Help, Color Themes, Solr Search, AWM, etc). Static list
> >>> - Main screenshot
> >>> - Summary text
> >>> - Additional content
> >>> - Target audience (User, Admin, Developer). Static list
> >>>
> >>> Notes:
> >>> - If no “main screenshot” is provided then the generated report will
> put the item in a Miscellaneous section
> >>>
> >>> For now I don’t want to handle other metadata for the releases notes,
> i.e. translations, upgrades, backward compat, tested browsers, etc).
> Precisely, I’m planning to write a “New and Networthy” application ATM, not
> a full “Release notes app”.
> >>>
> >>> The way it could be used is through a {{news/}} macro, e.g.: {{news
> from=“6.4” to=“8.2” [categories=“help,awm,...”]
> [targetAudience=“user,admin”] /}}.
> >>>
> >>> Usage
> >>> ==
> >>>
> >>> - There would be a page in the wiki to see the livetable corresponding
> to all the release notes news (the xproperties above)
> >>> - Above 

Re: [xwiki-devs] [Proposal] New best practice for app development: namespace restrictions

[Vincent Massol]

Now added to 
http://dev.xwiki.org/xwiki/bin/view/Community/ApplicationDevelopmentBestPractices

Thanks
-Vincent

> On 16 Sep 2016, at 14:35, Vincent Massol  wrote:
> 
> Hi,
> 
> Since XWiki 8.0 we now have a way to define in which namespace an extensions 
> work. See “xwiki.extension.namespaces” in 
> http://extensions.xwiki.org/xwiki/bin/view/Extension/XWiki+Commons+-+Extension+-+Repository+-+Maven#HCustomproperties
> 
> I’m proposing to add that apps should use this as a best practice in
> http://dev.xwiki.org/xwiki/bin/view/Community/ApplicationDevelopmentBestPractices
> 
> WDYT?
> 
> Thanks
> -Vincent

___
devs mailing list
devs@xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs