Skip to content

docs: update theme 1.9#736

Open
dgarcia360 wants to merge 1 commit intoscylladb:masterfrom
dgarcia360:docs-update-1.9
Open

docs: update theme 1.9#736
dgarcia360 wants to merge 1 commit intoscylladb:masterfrom
dgarcia360:docs-update-1.9

Conversation

@dgarcia360
Copy link
Collaborator

Motivation

Updates docs theme to 1.9.

Changelog: https://github.com/scylladb/sphinx-scylladb-theme/blob/master/docs/source/upgrade/CHANGELOG.md#190---26-february-2026

How to test

  1. Make sure you are using Python 3.11-3.14:

    python --version
    
  2. Install uv:

    make setupenv
    
  3. Build the docs:

    make preview
    
  4. Docs should render without errors at http://127.0.0.1:5500

@annastuchlik
Copy link

@dkropachev Please review.
I'm not sure what the failed security check does. From my perspective, the PR looks good.

Copy link

@Lorak-mmk Lorak-mmk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Comment on lines +5 to +7
permissions:
contents: read

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting that here contents: write is not present. I'm even more curious now about why PRs in other repos have it.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll defer to @dgarcia360

Copy link
Collaborator Author

@dgarcia360 dgarcia360 Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs-pr workflow doesn't need write permissions. It only builds the docs on new PRs for validation purposes.

The docs-pages workflow might need write permissions. Some repos (like this one) still use an older workflow that pushes to a github-pages branch, which requires contents: write. We propagated that permission from the theme repo, but it may not actually be necessary in repos using the newer GitHub Actions deploy workflow. I'll roll it back in those repos.

@Lorak-mmk
Copy link

@dkropachev I don't know what is this security/snyk (dkropachev) pipeline, and even though I am a maintainer I am unable to see the details of it and why it failed. Should I ignore this pipeline and merge PRs without passing CI?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants