Scroll Versions - best practice for release notes?

Follow

Dorte Jacobsen

May 18, 2021 08:51

Hi community,

I am looking for recommendations wrt to handling the release notes page in versioned spaces.

Right now we are basing release notes on the previous version of the release notes page, like all other pages in the versioned space. For example, our latest release is version 7.9 and we are currently working on version 7.10. This means that all pages in space version 7.10 are initially based on version 7.9, including the release notes page.

But the release notes page is obviously always changed for a new release. So what would you say is the best practice for such pages: is it what we are currently doing - or should we create a new page in version 7.10?

Looking forward to hearing what other teams are doing :-)

Thanks,
Dorte

0

• 

  Amit Kapoor May 19, 2021 12:33

  Hi Dorte,

  This is a sound approach. We do it differently but I don;t like it and I won't recommend that here.

  -Amit

   

  0

  Comment actions Permalink
• 

  Eva Mayrhofer May 20, 2021 06:05

  Hi there,

  we used to have different pages for each version of the release notes for a while. But we changed to have the same page changed for each version - as you describe.

  So our customers only had to check the same page for the most current release notes. If they are interested in some release notes of previous versions, they use the version picker to change to the previous version of the page.

  As far as I remember a main benefit was that we could use the same link pointing to the release note page. Before that we might have to update some links. Or we had to remember to quote the correct link to the respective page (e.g. in mails).

  But I, too, would love to hear about other solutions and ideas.

  Cheers, Eva

  0

  Comment actions Permalink
• 

  Andy Folland June 21, 2021 08:24

  Hello folks,
  
  For what it's worth, here's my €0.02.
  
  We publish from a master space to a different, live space, and our release notes page retains references and links to previous releases.
  
  However, this is problematic because if you remove a page in the latest release, any links from the old release notes to that page will subsequently be broken. I am therefore now tempted to have the published release notes page only display content relevant to the published release.
  
  Then if anyone ever needs to see the old release notes, they would have to request that from someone with access to the archived releases in the master space.
  
  BUT I haven't quite had the courage to implement this yet :-)
  
  

  0

  Comment actions Permalink

Please sign in to leave a comment.