Release Notes on Knowledge Base

[Jessica Medforth]

We currently have our Release Notes as an article on our Knowledge Base. We were finding that as more notes are added, the load time is suffering so we're in the process of creating individual pages for each release, and then linking them to a brief summary on the main release notes page instead. 

We're finding however, that now, all the individual pages are surfacing in the Knowledge Base search results. 

Is there a way to dictate which articles should, should not appear in search? 

Thanks in advance!

[Christopher Yen · Accepted solution]

Hi @Jessica Medforth welcome to the community!

For our company we use a label on external facing knowledge articles. You can set this up from Projects Settings > Knowledge base

[Jessica Medforth]

Hey @Christopher Yen thanks very much! This is definitely helpful.

I'm really new to KB in Atlassian. Is there any training videos or articles you would recommend to get me and my team up to speed on how to get the most out of the area of the product?

[Christopher Yen]

Glad it helped! Looking around I found this article. It's not super in depth but it does have a nice overview and some best practices.

The knowledge articles are essentially confluence pages so from our experience we have our service owners and agents follow a procedure to create and update articles directly from the confluence UI instead of JSM so they can organize pages and nest them under their team's or service's page and also create folders for internal vs external. I'm not sure if this is best practice but it works for us

[Jens Schumacher - Released_so]

Hi @Jessica Medforth 

Another alternative is a to use an app like Released.

There are a few benefits: 

• It helps you generate the release notes from your Jira tickets.
• Generates dynamic pages that won't show up in the search. 
• Provides additional filtering capabilities. 
• Allows users to subscribe to updates via email.

However, the app needs to be embedded via an embed macro provided by Aura and the likes but is also compatible with Scroll Viewport.

To give you an idea of what it looks like, here is a portal with release notes. 

With all that being said. I generally do recommend to make release notes available more prominently, whether it's in app or on your website.

It's a great conversion tool for prospects who haven't made up their mind, and a great retention tool for existing users. 

Disclaimer: I'm one of the co-founders of Released. If you have any questions, let me know!