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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update theme 1.5 #1201

Closed
dgarcia360 opened this issue Apr 4, 2023 · 3 comments 路 Fixed by #1308
Closed

docs: update theme 1.5 #1201

dgarcia360 opened this issue Apr 4, 2023 · 3 comments 路 Fixed by #1308
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@dgarcia360
Copy link
Contributor

dgarcia360 commented Apr 4, 2023

Related issue scylladb/sphinx-scylladb-theme#310

ScyllaDB Sphinx Theme 1.5 is now released 馃コ You can read more about all notable changes here.

Upgrade guide

For most repositories, we are sending pull-requests with new updates. Unfortunately, we cannot do this for this project since the docs workflows shared between all projects to build the docs were highly modified.

TIP: If you modify these workflows in your repository, you will need to maintain the changes. So instead, we recommend you to open an issue / pull-request in the sphinx-scylladb-theme repository so that all projects can benefit from the improvements you made.

Here you have resources to help you upgrade the docs toolchain to the latest version:

1.2. to 1.3

1.3 to 1.4

1.4 to 1.5

Do not hesitate to contact me (@dgarcia360 in Slack) if you face any issues during the process.

@tnozicka tnozicka added kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Apr 4, 2023
@dgarcia360 dgarcia360 changed the title docs: Update theme 1.4 docs: Update theme 1.5 Jun 2, 2023
@dgarcia360
Copy link
Contributor Author

dgarcia360 commented Jun 2, 2023

@annastuchlik We've released a new version. Updated the initial issue with the 1.4 to 1.5 migration guide.

@dgarcia360 dgarcia360 changed the title docs: Update theme 1.5 docs: update theme 1.5 Jun 2, 2023
@annastuchlik
Copy link

annastuchlik commented Jun 5, 2023

@tnozicka Could you move forward with this issue?
The Operator documentation is behind the rest of the docs, as it has the Sphinx theme version 1.3.5. The later releases have different fixes that should be applied to all project docs.

@annastuchlik
Copy link

@tnozicka ping

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants