search

scylladb / scylla-operator

The Kubernetes Operator for ScyllaDB
https://operator.docs.scylladb.com/
Apache License 2.0
332 stars 162 forks source link

Update to use latest sphinx-scylladb-theme #1893

Closed tnozicka closed 5 months ago

tnozicka commented 5 months ago

Latest sphinx-scylladb-theme contains several bug fixes we asked for so we should bump to >=1.7.1. This should make our docs look quite better.

tnozicka commented 5 months ago

Although the releases are out, the stable docs are on 1.6.x. The upgrade guide is available in master docs - https://sphinx-theme.scylladb.com/master/upgrade/1-6-to-1-7.html

@annastuchlik are the docs just stale or should we wait with v1.7.1 upgrade?

annastuchlik commented 5 months ago

Please do wait a little. We need to do it according to the schedule in https://github.com/scylladb/sphinx-scylladb-theme/issues/1035. We're hoping to be ready this week.

tnozicka commented 5 months ago

@annastuchlik sure, but I am slightly confused which event makes the release? How do we watch for the new releases to be available, so we know when to pick them up? For most project this is done by watching the GitHub releases and it was released there https://github.com/scylladb/sphinx-scylladb-theme/releases/tag/1.7.1

dgarcia360 commented 5 months ago

@tnozicka It's ok to update when a new tag is released. For the theme, updating the Python dependency directly is safe if only the patch version changes.

However, if the major or minor number are updated, it usually requires some additional changes, such editing other files than pyproject.toml. In these cases, we open issues for the affected teams or provide assistance to help them migrate to the latest versions during the following weeks after the release.

For updating to the latest version 1.7.1, please refer to this guide: https://sphinx-theme.scylladb.com/stable/upgrade/1-6-to-1-7.html