Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs theme to 1.8 #2132

Merged

Conversation

dgarcia360
Copy link
Contributor

@dgarcia360 dgarcia360 commented Sep 29, 2024

Related issue scylladb/sphinx-scylladb-theme#1229

ScyllaDB Sphinx Theme 1.8 is out 🥳!
image

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

  1. Clone this PR.

  2. Enter the docs folder, and run:

    make setup
    make preview
    
  3. 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:

    image

@scylla-operator-bot scylla-operator-bot bot added the do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. label Sep 29, 2024
Copy link
Contributor

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@scylla-operator-bot scylla-operator-bot bot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Sep 29, 2024
@rzetelskik
Copy link
Member

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

@scylla-operator-bot scylla-operator-bot bot added kind/machinery Categorizes issue or PR as related to Makefile, scripts or similar changes. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Sep 30, 2024
Copy link
Member

@rzetelskik rzetelskik left a comment

Choose a reason for hiding this comment

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

@dgarcia360 thanks for the PR!

The tests are failing with

The Poetry configuration is invalid:
  - Additional properties are not allowed ('package-mode' was unexpected)

so that's something that needs looking into. Edit: I updated the images in our CI, passing now.

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". Our contribution guide is outdated - sorry! We're working on updating it just now.

.github/dependabot.yml Outdated Show resolved Hide resolved
@rzetelskik
Copy link
Member

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

@rzetelskik
Copy link
Member

rzetelskik commented Oct 1, 2024

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
Copy link
Member

rzetelskik commented Oct 1, 2024

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

@dgarcia360
Copy link
Contributor Author

dgarcia360 commented Oct 2, 2024

@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!

@dgarcia360 dgarcia360 changed the title docs: update theme 1.8 Update docs theme to 1.8 Oct 2, 2024
@dgarcia360 dgarcia360 force-pushed the docs-update-theme-1.8 branch from 1cb3aea to 419bbbb Compare October 2, 2024 05:41
Copy link
Collaborator

@zimnx zimnx left a comment

Choose a reason for hiding this comment

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

lgtm
/assign rzetelskik

@scylla-operator-bot scylla-operator-bot bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 2, 2024
@rzetelskik rzetelskik self-requested a review October 2, 2024 08:23
Copy link
Member

@rzetelskik rzetelskik left a comment

Choose a reason for hiding this comment

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

/lgtm
Thanks!

@scylla-operator-bot scylla-operator-bot bot added the lgtm Indicates that a PR is ready to be merged. label Oct 2, 2024
Copy link
Contributor

[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:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@scylla-operator-bot scylla-operator-bot bot merged commit 1bf8c3c into scylladb:master Oct 2, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/machinery Categorizes issue or PR as related to Makefile, scripts or similar changes. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants