Creating Release Notes - Revision history

Anw: Minor formatting changes

2025-07-15T11:57:20Z

Minor formatting changes

← Older revision		Revision as of 13:57, 15 July 2025
Line 17:		Line 17:
	For the purposes of Release Notes, we will focus on section 2 - Patches/Release Notes.		For the purposes of Release Notes, we will focus on section 2 - Patches/Release Notes.

	=== Creating Release Notes ===		== Creating Release Notes ==
	This section has subsections for:		This section has subsections for:

Anw: Updated

2025-07-15T11:55:06Z

Updated

← Older revision		Revision as of 13:55, 15 July 2025
Line 50:		Line 50:
	* [[Creating a WCS Patch]]		* [[Creating a WCS Patch]]
	* [[Creating an ER]]		* [[Creating an ER]]
			* [[Creating a General Release Note]]

	=== On Browsing through categories ===		=== On Browsing through categories ===

Anw: Minor formatting changes

2025-07-15T09:04:47Z

Minor formatting changes

← Older revision		Revision as of 11:04, 15 July 2025
Line 17:		Line 17:
	For the purposes of Release Notes, we will focus on section 2 - Patches/Release Notes.		For the purposes of Release Notes, we will focus on section 2 - Patches/Release Notes.

			=== Creating Release Notes ===
	This section has subsections for:		This section has subsections for:

Line 27:		Line 27:
	* PORTAL Release Note		* PORTAL Release Note
	* General Release Note		* General Release Note



	Each sub-section shows examples of the naming conventions is use, which makes it much easier to copy and paste the titles, which are important, as they are shown in the PDF document produced, and they form the basis of browsing through Assist.		Each sub-section shows examples of the naming conventions is use, which makes it much easier to copy and paste the titles, which are important, as they are shown in the PDF document produced, and they form the basis of browsing through Assist.



	These are fairly easy and self-explanatory to use. Just fill in what you need, which is primarily the version, and then the devops numbers and the description of the fault and fix. There are other sections, and they may need more typing, but again, just point and click.		These are fairly easy and self-explanatory to use. Just fill in what you need, which is primarily the version, and then the devops numbers and the description of the fault and fix. There are other sections, and they may need more typing, but again, just point and click.


	The pages created should save to the correct categories, to allow them to be easily browsed.		The pages created should save to the correct categories, to allow them to be easily browsed.

	== Using the Templates ==		=== Using the Templates ===
	In general, follow these steps:		In general, follow these steps:

Line 50:		Line 51:
	* [[Creating an ER]]		* [[Creating an ER]]

	== On Browsing through categories ==		=== On Browsing through categories ===
	From the main page:		From the main page:

Line 76:		Line 77:
	* Category:Glossaries - Product glossaries. Copy and paste, or include in your Assist pages with <nowiki>{{GlossaryName}}</nowiki>		* Category:Glossaries - Product glossaries. Copy and paste, or include in your Assist pages with <nowiki>{{GlossaryName}}</nowiki>
	* Category:Incomplete - a list of all incomplete pages, so we can keep things up to date.		* Category:Incomplete - a list of all incomplete pages, so we can keep things up to date.

	[[Category:General]]		[[Category:General]]
	[[Category:ASSIST]]		[[Category:ASSIST]]

Anw: Minor formatting changes

2025-07-15T09:00:31Z

Minor formatting changes

← Older revision		Revision as of 11:00, 15 July 2025
Line 1:		Line 1:
	This guide is an overview to creating release notes for all systems of all types. There are also detailed guides that are referenced below.		This guide is an overview to creating release notes for all systems of all types. There are also detailed guides that are referenced below.

	=== Overview ===		== Overview ==
	On the main page of the Calidus Hub, if you are logged in, you will see a new page option labelled as [[Help:CreateNewPage\|Create New Pages from Templates]]:		On the main page of the Calidus Hub, if you are logged in, you will see a new page option labelled as [[Help:CreateNewPage\|Create New Pages from Templates]]:

Line 37:		Line 37:
	The pages created should save to the correct categories, to allow them to be easily browsed.		The pages created should save to the correct categories, to allow them to be easily browsed.

	=== Using the Templates ===		== Using the Templates ==
	In general, follow these steps:		In general, follow these steps:

Line 50:		Line 50:
	* [[Creating an ER]]		* [[Creating an ER]]

	=== On Browsing through categories ===		== On Browsing through categories ==
	From the main page:		From the main page:

Anw: Initial Creation

2025-07-15T08:57:08Z

Initial Creation

New page

This guide is an overview to creating release notes for all systems of all types. There are also detailed guides that are referenced below.

=== Overview ===
On the main page of the Calidus Hub, if you are logged in, you will see a new page option labelled as [[Help:CreateNewPage|Create New Pages from Templates]]:

This page is structured to aid getting into the different document/page generation bits, with some copyable examples.

For example:

* There is a TOC, so you can go straight to the type of document you want to create.
* The TOC is categorised, so you can do
** Pages/Documents - plain pages
** Patches/Release - Notes
** Specific - Document Types
** Category - Utility Pages

For the purposes of Release Notes, we will focus on section 2 - Patches/Release Notes.

This section has subsections for:

* WMS or TMS Patch
* WMS or TMS Emergency Release
* WCS Patch
* EPOD Device/APK Release Note
* EPOD Admin/Server Release Note
* PORTAL Release Note
* General Release Note

Each sub-section shows examples of the naming conventions is use, which makes it much easier to copy and paste the titles, which are important, as they are shown in the PDF document produced, and they form the basis of browsing through Assist.

These are fairly easy and self-explanatory to use. Just fill in what you need, which is primarily the version, and then the devops numbers and the description of the fault and fix. There are other sections, and they may need more typing, but again, just point and click.

The pages created should save to the correct categories, to allow them to be easily browsed.

=== Using the Templates ===
In general, follow these steps:

* Enter your title
* Click the button.
* If necessary, click the '''Create''' button on the top-right to switch to Visual Editing.
* Just type.

There are specific guides to the different types here:

* [[Creating a WCS Patch]]
* [[Creating an ER]]

=== On Browsing through categories ===
From the main page:

There are sections for each Product.

Each link here includes the appropriate product release note categories in the results, so you can drill down.

There are sections for:

* Category:Documents by Type - a list of all document types. Under each of these they are typically sub-categorised
** Configuration - subcat by customer
** Emergency Releases - subcat by product
** Estimates - subcat by customer
** Functional Specifications - subcat by customer
** General
** Patches - subcat by product
** User Guides - subcat by customer
** Release Notes - subcat by product
** Requirements (Solution Designs) - subcat by customer
** Small Change Requests - subcat by customer
** Support Documents
** Technical Guides
* Category:Documents by Client - a list of all customers. Typically sub-categorised by document type.
* Category:Documents by Product - a list of all products. Typically sub-categorised by document type.
* Category:Glossaries - Product glossaries. Copy and paste, or include in your Assist pages with <nowiki>{{GlossaryName}}</nowiki>
* Category:Incomplete - a list of all incomplete pages, so we can keep things up to date.

[[Category:General]]
[[Category:ASSIST]]