Since the documentation url is already filled in our jira issue, could we associate the issue number to Release Notes change, and so the url of the documentation is automatically pulled from jira ? This way we could also add a link to the jira issue.
My 2 cents, Le mar. 20 nov. 2018 à 13:12, Marius Dumitru Florea < mariusdumitru.flo...@xwiki.com> a écrit : > +1 > > On Sun, Nov 18, 2018 at 3:56 PM Vincent Massol <vinc...@massol.net> wrote: > > > Hi devs, > > > > This is something I mentioned a few times (just did on IRC/matrix an hour > > ago too) but I don’t know if we have an agreement about to, so I’m > making a > > proposal. > > > > The idea is that I think it would be nice for users to be able to the > read > > the RN and for each item to be able to navigate to the reference > > documentation to know more about the topic. > > > > Thus the proposal is to always add a link to the reference doc in RN > items. > > > > For example I added a link here: > > > > > https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/10.10RC1/#HAllowwikimacrostoindicatethetypeofparameters > > > > When I created the RN app I had hesitate to have a field for that but I > > thought it be nicer if the links were in the text (better flow) and it > > would take less visual space (if we have a field we’ll need to add the > info > > somewhere which will take more space). The downside is that everyone is > > forgetting to do it and it's not enforceable automatically. > > > > WDYT? > > > > Thanks > > -Vincent > > > > > -- Guillaume Delhumeau (guillaume.delhum...@xwiki.com) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
