Update release notes (#80)

* Update release notes

* Update version

* Update screenshot

CHANGELOG.md

@@ -5,27 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+Released changes are shown in the
+[documentation release notes](docs/docs/getting-started/changelog.md).
+
 ## [Not released]
 
 ### Added
-- Ability to get predictions without postprocessing in the exploration space. (Only back end for
-  now)
-- New Smart Tags `pipeline_disagreement` and `incorrect_for_all_pipelines` as a first step for pipeline comparison.
-- Links on top words to filter utterances that contain it.
-- `/confusion_matrix` now supports `normalized:bool` to get counts versus normalized confusion matrix.
-- added "Without Postprocessing" feature to enable/disable post processing feature on the data
 
 ### Changed
 - Renamed our docker images to use `servicenowdocker` registry on Docker Hub.
 
 ### Deprecated/Breaking Changes
 
-
 ### Removed
 
 ### Fixed
 
 ### Security
-
-Released changes are shown in the
-[documentation release notes](docs/getting-started/release-notes.md).

CITATION.cff

@@ -1,4 +1,4 @@
-cff-version: 1.0.0
+cff-version: 1.1.0
 message: "If you use Azimuth in your projects, please cite it as below."
 authors:
 - family-names: "Branchaud-Charron"
@@ -18,7 +18,7 @@ authors:
 - family-names: "Babu"
   given-names: "Nandhini"
 title: "Azimuth, an open-source dataset and error analysis tool for text classification"
-version: 2.0.0
+version: 2.1.0
 doi: 10.5281/zenodo.6511558
-date-released: 2022-04-20
+date-released: 2022-05-27
 url: "https://github.com/ServiceNow/azimuth"

docs/docs/getting-started/changelog.md

@@ -0,0 +1,14 @@
+# Releases
+
+## [2.1.0] - 2021-05-27
+
+- Ability to get predictions without postprocessing in the exploration space. See section "Excluding
+  Post-Processing" [here](../user-guide/exploration-space/index.md).
+- New Smart Tags `pipeline_disagreement` and `incorrect_for_all_pipelines` as a first step for
+  pipeline comparison. See section "Pipeline Comparison" [here](../key-concepts/smart-tags.md).
+- Links on top words to filter utterances that contain it. See the section "Word
+  Clouds" [here](../user-guide/exploration-space/performance-overview.md).
+
+## [2.0.0] - 2021-04-12
+
+First public release.

docs/docs/index.md

@@ -15,7 +15,7 @@ current focus is on text classification.
 ## :material-file-tree: Documentation Structure
 
 * [:material-link: Getting Started](getting-started/index.md) contains all the instructions to **
-  install** and **launch** the app.
+  install** and **launch** the app. It also details the **changelog** of our releases.
 * [:material-link: Key Concepts](key-concepts/index.md) explains the different **concepts and
   analyses** that are provided in Azimuth to perform dataset and error analysis.
 * [:material-link: User Guide](user-guide/index.md) goes **screen per screen** to explain the

docs/mkdocs.yml

@@ -54,6 +54,8 @@ nav:
       - getting-started/a-install.md
       - getting-started/b-basics.md
       - getting-started/c-run.md
+      - Changelog:
+          - Releases: getting-started/changelog.md
   - Key Concepts:
       - key-concepts/index.md
       - key-concepts/smart-tags.md

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "azimuth"
-version = "2.0.1"
+version = "2.1.0"
 description = "Azimuth provides an unified error analysis experience to data scientists."
 readme = "README.md"
 authors = ["Butter-ball team <xaicaps@servicenow.com>"]