+1 I agree this would help the user to find related information about the feature and the changes done. We already do this practice in the majority of cases.
I would even say that when providing the link it would be great if we would add the version number in the link, for example https://www.xwiki.org/xwiki/bin/viewrev/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/WebHome?rev=98.4#HParameters This way the release notes will be valid after 1 year or more. Because on xwiki.org we are supporting only the latest version, some documentation goes missing, some anchors get deleted, etc. Having the version number in the URL makes sure that the reader of the RN will know exactly how the documentation was indented to look like at the moment the feature was released. Thanks, Caty On Mon, Nov 19, 2018 at 11:15 AM Adel Atallah <[email protected]> wrote: > Hello, > > +1 to enforce the link to the documentation. > > We could find a nice way to show the link by adding an icon next to > the RN note or put the link on the title for instance. > > Thanks, > Adel > > On Sun, Nov 18, 2018 at 2:56 PM Vincent Massol <[email protected]> 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 > > >
