Merge pull request #271 from noi-techpark/issue-268-changelog-entries

Issue 268 changelog entries

source/appendices.rst

@@ -1,3 +1,5 @@
+.. _appendices:
+
 Appendices
 ==========
 

source/changelog.rst

@@ -1,5 +1,10 @@
-Changelog
-=========
+.. _changelogs:
+
+Changelogs
+==========
+
+.. versionchanged:: 2022.10 this section has been split, now there is
+   a dedicated Changelog page for each year.
 
 This section contains the Changelog of the |odh| project's
 documentation.
@@ -17,273 +22,8 @@ documentation.
    `version` is identified by a string :strong:`YYYY.MM`, in which
    `YYYY` is the year and `MM` the month of the release.
 
-.. changelog::
-   :version: 2021.03
-   :released: 31 March 2021
-
-   .. change::
-      :tags: Improvement
-      :tickets: 194
-
-      Add :strong:`changelog` extension.
-
-   .. change::
-      :tags: Bugfix
-      :tickets: 199
-
-      Fix layout of datasets in :ref:`Other Domains <other-domains-datasets>`.
-
-   .. change::
-      :tags: Improvement
-      :tickets: 203
-
-      Add AlpineBits to the :ref:`data-access` section.
-
-.. changelog::
-   :version: 2021.04
-   :released: 30 April 2021
-
-
-   .. change::
-      :tags: Improvement
-      :tickets: 206
-
-      Add to each dataset a direct permalink that can be copied and
-      sent to third party.
-
-   .. change::
-      :tags: Improvement
-      :tickets: 208
-
-      * Replace tabs in the howto list with subsections.
-      * Remove the mobility howto for deprecated API v1.
-      * Reduce size of images in howtos and align them if layout
-        allows.
-
-   .. change::
-      :tags: Bugfix
-      :tickets: 208
-
-      Add correct images to `How to Access Analytics Data in the
-      Mobility Domain` howto.
-
-   .. change::
-      :tags: New Feature
-      :tickets: 204
-
-      New Howto: :ref:`howto-r`
-
-   .. change::
-      :tags: Bugfix
-      :tickets: 212
-
-      * Remove drop downs from all the lists of :ref:`datasets
-        <mobility-datasets>` (Mobility, Tourism, Other)
-      * fix the panel's width to avoid scrollbars whenever possible.
-
-   .. change::
-      :tags: Bugfix
-      :tickets: 213
-
-      Add troubleshooting section to :ref:`R howto <howto-r>`.
-
-.. changelog::
-   :version: 2021.05
-   :released: 31 May 2021
-
-   .. change::
-      :tags: Improvement
-      :tickets: 209
-
-      A lot of improvements have been added to the general structure
-      of the documentation, the most important being:
-
-      * reorder ToC and make some section more prominent
-      * made bash code snippets more usable
-      * made accessing methods more immediate to see
-
-      For more details, please check the reference.
-
-   .. change::
-      :tags: Improvement
-      :tickets: 214
-
-      The technical content of the `getting started` howtos has been
-      moved to the `Datasets` section, making them shorter. Also a few
-      examples have been added to :ref:`get-started-mobility`.
-
-.. changelog::
-   :version: 2021.06
-   :released: 30 June 2021
-
-   .. change::
-      :tags: Change, Improvement
-      :tickets: 220
-
-      The Tourism domain was modified and improved in several points,
-      which are reflected in the documentation:
-
-      * New Swagger and API URLs
-      * Localised methods have been definitely removed
-      * A new `extlink` to shorten URLs of tourism API in the
-        documentation source code has been introduced
-      * The :ref:`tourism-data-howto` article has been modified to
-        include the API browsable interface
-      * Tourism datasets have been ordered lexicographically
-
-   .. change::
-      :tags: Change, Improvement
-      :tickets: 219
-
-      The description of the new Knowledge Graph underlying the
-      Mobility domain has been added. Also the :ref:`SPARQL Howto
-      <howto-sparql>` has been updated to reflect the new precooked
-      queries and layout.
-
-.. changelog::
-   :version: 2021.08
-   :released: 31 August 2021
-
-   .. change::
-      :tags: New Feature
-      :tickets: 224
-
-      New filters for the tourism domain: rawfilter, rawsort, and
-      removenullvalues.
-
-
-   .. change::
-      :tags: Change, Improvement
-      :tickets: 223
-
-      Keycloak has been introduced as default authentication method
-      for the |ODH|.
-
-   .. change::
-      :tags: Change
-      :tickets: 231
-
-      The URL of the Tourism API has been updated
-
-   .. change::
-      :tags: Bugfix, Improvement
-      :tickets: 227
-
-      Update old URLS, fix broken links.
-
-   .. change::
-      :tags: Improvement
-      :tickets: 232
-
-      Add statistics about Tourism's Open Data and CC0-licensed images
-
-   .. change::
-      :tags: Improvement
-      :tickets: 221
-
-      Rearrange subsections in sections :ref:`data-access` and
-      :ref:`available_datasets`, add a new FAQ entry and reformat FAQ
-      section.
-
-   .. change::
-      :tags: Improvement
-      :tickets: 233
-
-      The `sphinx-panels
-      <https://github.com/executablebooks/sphinx-panels>`_ extension
-      has been replaced by its successor, `sphinx-design
-      <https://github.com/executablebooks/sphinx-design>`_.
-
-.. changelog::
-   :version: 2021.09
-   :released: 30 September 2021
-
-   .. change::
-      :tags: Bugfix
-      :tickets: 244
-
-      Fix requirements.txt file.
-
-   .. change::
-      :tags: Improvement, New Feature
-      :tickets: 225
-
-      AlpineBits DestinationData and HotelData have now a dedicated
-      page.
-
-.. changelog::
-   :version: 2021.12
-   :released: 31 December 2021
-
-   .. change::
-      :tags: New Feature
-      :tickets: 247
-
-      Add WeatherHistory dataset.
-
-
-.. changelog::
-   :version: 2022.03
-   :released: 31 March 2022
-
-   .. change::
-      :tags: New Feature
-      :tickets: 250
-
-      Add section :ref:`quickstart`.
-
-.. changelog::
-   :version: 2022.03
-   :released: 31 March 2022
-
-   .. change::
-      :tags: Improvement
-      :tickets: 251
-
-      Major changes to sectioning: unify sections :ref:`project-overview`,
-      :ref:`getting-involved`, and :ref:`data-access`; move description of
-      domains to :ref:`available_datasets` section, move
-      :ref:`architecture-odh` to :doc:`appendices`.
-
-.. changelog::
-   :version: 2022.05
-   :released: 31 May 2022
-
-   .. change::
-      :tags: Improvement
-      :tickets: 255
-
-      Slight improvements to the section names, documentation
-      for GitHub workflow moved to howto.
-
-.. changelog::
-   :version: 2022.05
-   :released: 31 May 2022
-
-   .. change::
-      :tags: Improvement
-      :tickets: 253
-
-      The custom theme was modified to keep it updated with the
-      upstream one. Also, contact information were changed.
-
-.. changelog::
-   :version: 2022.06
-   :released: 30 June 2022
-
-   .. change::
-      :tags: Improvement
-      :tickets: 259
-
-      Support for Mobility API v1 has been dropped and is no longer available.
-
-
-.. changelog::
-   :version: 2022.10
-   :released: 31 October 2022
-
-   .. change::
-      :tags: Change
-      :tickets: 255
-
-      FAQ were moved to the wiki.
+.. toctree::
+   :hidden:
+   :glob:
+
+   changelogs/*