1. STAEDEAN documentation guidelines and processes
  2. Documentation processes
  3. Create documentation for D365 F&SCM

Maintain Release notes pages

On https://docs.staedean.com/, a specific section is available where you can find the latest release notes for the STAEDEAN D365 F&SCM products: https://docs.staedean.com/Release notes/.

Because of the quarterly release pattern, about the second week of each quarter, this Release notes section must be updated.


Technical writer Technical writer Start Start Get release notes from product teams Get release notes from product teams To update the release notes section on https://docs.staedean.com/, you need the latest release notes. Get the release notes from the product teams. Usually, you can find the release notes in the Files section of the applicable product team channel on Teams. Otherwise, contact the product owner. The release notes must be in PDF format. So, if the release notes are in Word format, open the document and save it as PDF file. Add release notes to Azure Storage Add release notes to Azure Storage Add the release note PDF files to the 'releasenotes' folder in Azure Storage. You can find the 'releasenotes' folder in the 'To-Increase Production' Azure environment, in the 'sadocswebsite' storage account, under 'Blob Containers' -> '$web'. You can do so, for example, using the Azure Storage Explorer: Update Release notes solution Update Release notes solution Update the release notes solutions in RapidValue on the documentation VM. The current documentation VM is: https://ti-10-docs4a7b1204826a3ce9devaos.cloudax.dynamics.com/ For each pillar/area, a separate release notes solution exists: Release notes - Data Management - Doc Release notes - Equipment Rental -Doc Release notes - Manufacturing - Doc Release notes - Others - Doc Note: The Life Sciences release notes are published on a different platform/website. This is managed by the Life Sciences team.   In each pillar release notes solution, for each product or product suite, a separate entry exists.   Only list the five latest release notes. So, If you add a new release notes reference, and already five release notes are listed, remove the oldest release notes reference.   The release notes reference has these parts: Protocol: The protocol always must be: https:// URL: Refers to the applicable release notes PDF file in the Azure Storage. The URL has two parts: [path to storage]/[document name incl. .pdf]. The 'path' to storage always is: docs.staedean.com/releasenotes/ Example: https://docs.staedean.com/releasenotes/Release Notes for RapidValue BPM Suite -10.0.29.38.pdf In Teams, in the STAEDEAN Documentation team, in files/STAEDEAN Docs Backup/Website backup, you can find a note pad file called ReleaseNotes-Hyperlinks.txt. You can use this file to quickly create the release note reference hyperlinks. Procedure 1. Click Business process management. 2. In the list, find and select the desired release notes solution. 3. Click Model. 4. Click Business processes. 5. Click Edit. 6. In the tree, select 'the desired product entry.'. 7. On the Details tab, in the Description section, update the release notes references. Notes When ready, don't forget to make a backup of the 'Release notes - Base' solution. End End Publish release notes website Publish release notes website A specific sub-website is used to publish the release notes for the STAEDEAN products for D365 F&SCM: Release notes. The Release notes website has references to the release notes solutions and to the Life Sciences release notes website. Publish the release notes website to https://docs.staedean.com/. Screenshot of the release notes website overview: Screenshot of the release notes website tiles: Notes When you have updated the release notes website, make a backup of it and save it to this folder in Teams, in the STAEDEAN Documentation team: files/STAEDEAN Docs Backup/Website backup.

Activities

Name Responsible Description

Get release notes from product teams

Technical writer

To update the release notes section on https://docs.staedean.com/, you need the latest release notes.

Get the release notes from the product teams. Usually, you can find the release notes in the Files section of the applicable product team channel on Teams. Otherwise, contact the product owner.

The release notes must be in PDF format. So, if the release notes are in Word format, open the document and save it as PDF file.

Add release notes to Azure Storage

Technical writer

Add the release note PDF files to the 'releasenotes' folder in Azure Storage.

You can find the 'releasenotes' folder in the 'To-Increase Production' Azure environment, in the 'sadocswebsite' storage account, under 'Blob Containers' -> '$web'.

You can do so, for example, using the Azure Storage Explorer:

Update Release notes solution

Technical writer

Update the release notes solutions in RapidValue on the documentation VM. The current documentation VM is: https://ti-10-docs4a7b1204826a3ce9devaos.cloudax.dynamics.com/

For each pillar/area, a separate release notes solution exists:

  • Release notes - Data Management - Doc
  • Release notes - Equipment Rental -Doc
  • Release notes - Manufacturing - Doc
  • Release notes - Others - Doc

Note: The Life Sciences release notes are published on a different platform/website. This is managed by the Life Sciences team.

 

In each pillar release notes solution, for each product or product suite, a separate entry exists.

 

Only list the five latest release notes. So, If you add a new release notes reference, and already five release notes are listed, remove the oldest release notes reference.

 

The release notes reference has these parts:

  • Protocol: The protocol always must be: https://
  • URL: Refers to the applicable release notes PDF file in the Azure Storage. The URL has two parts: [path to storage]/[document name incl. .pdf]. The 'path' to storage always is: docs.staedean.com/releasenotes/
    Example: https://docs.staedean.com/releasenotes/Release Notes for RapidValue BPM Suite -10.0.29.38.pdf

In Teams, in the STAEDEAN Documentation team, in files/STAEDEAN Docs Backup/Website backup, you can find a note pad file called ReleaseNotes-Hyperlinks.txt. You can use this file to quickly create the release note reference hyperlinks.

Publish release notes website

Technical writer

A specific sub-website is used to publish the release notes for the STAEDEAN products for D365 F&SCM: Release notes.

The Release notes website has references to the release notes solutions and to the Life Sciences release notes website.

Publish the release notes website to https://docs.staedean.com/.

Screenshot of the release notes website overview:

Screenshot of the release notes website tiles: