Update docs theme to 1.8

scylladb / scylla-operator

The Kubernetes Operator for ScyllaDB

https://operator.docs.scylladb.com/

Apache License 2.0

339 stars 175 forks source link

Update docs theme to 1.8 #2132

Closed dgarcia360 closed 1 month ago

dgarcia360 commented 1 month ago

ScyllaDB Sphinx Theme 1.8 is out 🥳!

Here's a summary of changes:

Dark theme support for a fresh new look.
Updated branding assets including new logos and mascots.
Improved build process by recommending the inclusion of the poetry.lock file to ensure consistent dependencies in your CI/CD pipeline.
New tooltip component to add more context to glossary terms, configuration parameters, or any other elements without cluttering the page.

You can read more about all the notable changes here.

How to test this PR

Clone this PR.
Enter the docs folder, and run:
```
make setup
make preview
```
Open http://localhost:5500 in your browser. The doc should render without errors, and the version should be Sphinx Theme version (see the footer) must be 1.8.x:

scylla-operator-bot[bot] commented 1 month ago

Hi @dgarcia360. Thanks for your PR.

I'm waiting for a scylladb member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

rzetelskik commented 1 month ago

/kind machinery /priority important-longterm /ok-to-test

rzetelskik commented 1 month ago

we'll need to update our CI first as we're at poetry 1.5

rzetelskik commented 1 month ago

Poetry image has been updated. /test docs docs-multiversion

Edit:

The currently activated Python version 3.9.18 is not supported by the project (^3.10).
Trying to find and use a compatible version.

Python version in the image needs updating as well...

rzetelskik commented 1 month ago

Python was updated to ~3.12~ 3.11 in poetry-1.8 image. /test docs docs-multiversion

dgarcia360 commented 1 month ago

@rzetelskik @zimnx

Iirc we didn't have that good of an experience with depandabot and had to manually fix the PRs either way, so I'm personally not a fan of adding this. Imo it shouldn't be mixed in this PR either way.

Deleted the dependabot file, we can discuss if we want to include it as part of a separate issue

@rzetelskik

Please update the commit and PR title to describe the change using the verb in a base form, like "Update docs theme to 1.8".

Done!

scylla-operator-bot[bot] commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dgarcia360, rzetelskik, zimnx

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/scylladb/scylla-operator/blob/master/OWNERS)~~ [zimnx] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment