Question

Can I get release notes into a wiki article (so they can easily be made available publicly) either statically as an export or dynamically-updating in the page?

Case FC1865608

Answer 1

There isn't a built-in way to do this as an export or as a dynamically-updating list. You can:

Static

1. Generate the HTML version of the release notes from Reports -> Release Notes and copy and paste from the view of that into the wiki article. It should preserve the formatting.
2. Use the XML API to modify the raw HTML of the wiki article to insert the actual HTML of the release notes.

Dynamic

You could write a plugin which creates a formatted release notes list via a WikiBlock which you can insert into the article (like the dynamically-updating TOC Plugin)

Up-vote this question to show your support for adding these features.

Answer 2

I like the idea of the plugin ... except that the content of WikiBlocks does not seem to be searchable. I tried searching for content that was within a Code Snippet, and FB would not find the article. If I moved the content out of the Code Snippet into regular content, the article was found via search. It would be very useful if the WikiBlock content were indexed/searchable just like regular content. Without that, there is no reasonable way to make release notes public. The static approach mentioned above creates a highly redundant scenario. If a release note is added or changed, the static page becomes out of date.

It seems reasonable, if not essential, to make release notes automatically appear and act as if they are wiki articles.

Is there anyway that a plugin can override the search function to automatically search and display release notes as articles?