Release 1.4.1 (#721)

* Fix broken link * Release 1.4.1
scylladb · Mar 13, 2023 · 9edcf4b · 9edcf4b
1 parent 8a1877c
commit 9edcf4b
Show file tree

Hide file tree

Showing 5 changed files with 152 additions and 116 deletions.
diff --git a/docs/source/upgrade/1-3-to-1-4.rst b/docs/source/upgrade/1-3-to-1-4.rst
@@ -0,0 +1,33 @@
+Migrating from 1.3 to 1.4
+=========================
+
+This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme.
+
+How to check your current theme version
+---------------------------------------
+
+The theme version is displayed in the footer of the project's documentation site.
+
+.. image:: version.png
+
+If your project theme's version is **>=1.3**, follow this guide to get the latest version.
+
+Upgrade to version 1.4
+----------------------
+
+Here are the main breaking changes between the 1.3 and 1.4 versions.
+
+#. Update the following Python dependencies in ``docs/pyproject.toml``:
+
+    .. code-block::
+
+        sphinx-scylladb-theme = "~1.4.1"
+
+#. Build the docs locally:
+
+    .. code-block::
+
+        cd docs
+        make preview
+
+#. Fix any warnings that appear in the terminal.
diff --git a/docs/source/upgrade/CHANGELOG.md b/docs/source/upgrade/CHANGELOG.md
@@ -5,6 +5,19 @@ 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).
 
+## 1.4.1 - 13 March 2023
+
+**IMPORTANT**: For more information on how to update, see [Migrating from 1.3 to 1.4](https://sphinx-theme.scylladb.com/stable/upgrade/1-3-to-1-4.html).
+
+### Added
+
+- [#652](https://github.com/scylladb/sphinx-scylladb-theme/pull/652): The docs builds now raises a warning if a RST or MD file has underscores in the filename. 
+- [#696](https://github.com/scylladb/sphinx-scylladb-theme/pull/696): The announcement banner can be managed from Google Tag Manager.
+
+### Fixed
+
+- [#720](https://github.com/scylladb/sphinx-scylladb-theme/pull/720): In 1.3.5, we introduced a bug that caused some breadcrumbs to not have a link. This is now fixed.
+
 ## 1.3.5 - 24 Feb 2023
 
 ### Updated
@@ -54,6 +67,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## 1.3.1 - 19 Aug 2022
 
+**IMPORTANT**: For more information on how to update, see [Migrating from 1.2 to 1.3](https://sphinx-theme.scylladb.com/stable/upgrade/1-2-to-1-3.html).
+
 ### Added
 
 - [#525](https://github.com/scylladb/sphinx-scylladb-theme/issues/525): When a user clicks on **Create an issue** button, the issue is now created with the prefix `docs:` and the label `documentation`.

diff --git a/docs/source/upgrade/index.rst b/docs/source/upgrade/index.rst
@@ -5,6 +5,7 @@ Upgrade guides
    :maxdepth: 2
    :hidden:
 
+   1-3-to-1-4
    1-2-to-1-3
    1-1-to-1-2
    1-0-to-1-1
@@ -13,6 +14,7 @@ Upgrade guides
 
 .. panel-box::
 
+  * :doc:`Migrating from 1.3 to 1.4 <1-3-to-1-4>`
   * :doc:`Migrating from 1.2 to 1.3 <1-2-to-1-3>`
   * :doc:`Migrating from 1.1 to 1.2 <1-1-to-1-2>`
   * :doc:`Migrating from 1.0 to 1.1 <1-0-to-1-1>`