Release Notes

Template document: https://docs.google.com/document/d/1nZWIaKXKs6oHTIkHhGVgPY6Uex3aP3llTY9xMTHhRh0/edit?pli=1

About this Document

This document provides details of features and enhancements made to the Sunbird platform for the release version X.X.X and hotfixes X.X.X.

Release Version

Release versionRelease Date

Month dd, 20XX

X.X.X (main Release)

Month dd, 20XX

New Features

No.

Jira Ticket Number

Description

1

Title of the JIRA ticket

Add the description here

Enhancements / Technical tasks

No.

Jira Ticket Number

Description

1

Title of the JIRA ticket

Add the description here

Open/Known Bugs

No.

Jira Ticket Number

Description

1

Title of the JIRA ticket

Add the description here

Installation or Upgrade

  • Fresh installation (link/tags)

  • How to Upgrade (link/tags)\

Configuration/Environment variable changes

Service Name

Configuration

Configuration changes related to API

Form API’s update

Primary category definition need to update

Deprecations and Removals:

Examples:

  • API’s which are deprecated/removed in this release

  • Configuration

  • Environment

  • NPM package is not supported

Breaking changes (The existing features will break the if we don’t do the below actions)

Examples:

  • If there is any migration activity

  • If any api's are changed/updated which will break the previous existing functionality

Dependent Building Blocks Releases

As part of the Sunbird ED release x.x.x, this document also includes the updates taken from

\

Last updated