Skip to content

Commit

Permalink
docs: update changelog and values.yaml changelog for showcase projects
Browse files Browse the repository at this point in the history
  • Loading branch information
ciyer committed Oct 17, 2023
1 parent 6bb68c0 commit 875c61d
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
.. _changelog:


0.41.0
------

Renku ``0.41.0`` allows the RenkuLab homepage to be configured to highlight chosen projects.

Internal Changes
~~~~~~~~~~~~~~~~~~~

**🌟 New Features**

- 🚀 **UI**: [Showcase] Admins can designate projects to be showcased on the home page, which will show them
in the showcase section of the home page. (`#2799 <https://github.com/SwissDataScienceCenter/renku-ui/pull/2799>`_).


This is a breaking change to the values file and it requires minor edits to the following field:

- ``ui.homepage`` removed the unused ``projects`` field and added the ``showcase`` field.

For more details please refer to the explanation in ``helm-chart/values.yaml.changelog.md``.

0.40.0
------

Expand Down
18 changes: 18 additions & 0 deletions helm-chart/values.yaml.changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,24 @@ For changes that require manual steps other than changing values, please check o
Please follow this convention when adding a new row
* `<type: NEW|EDIT|DELETE> - *<resource name>*: <details>`

## Upgrading to Renku 0.41.0

The UI includes a feature that allows projects to be displayed in the _Showcase_ section of the RenkuLab home page.
This is an improvement that has been planned for a while, and the _ui.homepage.projects_ field was introduced into the
values file with the intention of being used to configure this. Support for that field was never actually implemented, and
as part of the implementation of this feature, the configuration structure was changed somewhat.

To clean up, please remove the following field:

* DELETE - `ui.homepage.projects`

To keep the RenkuLab homepage as before, ensure that the following field/value has been added:

* NEW - `ui.homepage.showcase.enabled: false`

Follow the _Homepage_ section of the how-to guide for admins to learn how to configure this feature if you wish to
highlight showcase projects.

## Upgrading to Renku 0.39.0

This is a big change to the Renku Helm chart. We have now combined all Renku components to be present
Expand Down

0 comments on commit 875c61d

Please sign in to comment.