Changelog¶

#1277: Documentation on Dependabot support, explaining configuration, update frequency, and handling vulnerability alerts.

#1277: Updated cookie configuration to ensure cookies are available across all .scylladb.com subdomains.

#1277: Corrected Dependabot ignore property that was unintentionally excluding all dependencies, now allowing only specified dependencies to receive updates.

#1257: The theme now respects browser and system preferences for dark mode by default.

#1257: Switched from localStorage to cache for storing settings such as dark mode and announcement preferences. This allows for shared preferences across projects.

#1246: Tooltips now correctly render glossary entries without relying on whether the glossary file was pre-loaded by Sphinx.

#1260: Fixed a brief flash of light mode when navigating between pages in dark mode.

#1258: Styled legacy panel boxes defined inside raw HTML directives to display correctly in dark mode.

#1267: Removed the previous icon library.

#1266: Completely dropped Font Awesome support, removed the latest icons, and cleaned up the dependency.

#1163: Introduced a new component to display tooltips in the documentation. This feature supports both glossary entries and custom text.

#1180: Documented how to create links to configuration parameters.

#1210: Added dark theme support.

#1210: Introduced a new custom library for icons.

#1175: Adjusted script loading order so that Google Tag Manager scripts load before generic scripts.

#1186: Recommend including the poetry lock file in the repository to ensure consistent dependencies are installed in the CI/CD pipeline.

#1190: Updated the ScyllaDB logo and mascots.

#1206: Pinned sphinx-autobuild version to avoid a known issue.

#1189: Removed the newsletter from the footer.

#1217: Dropped Font Awesome libary support for icons.

#1157 Set sphinx-notfound-page to 0.1.2 to fix the issue raised by the latest version of the extension. More details in https://github.com/readthedocs/sphinx-notfound-page/issues/240

#1123: Compatibility with Python 3.12.

#1123: Replaced Flake8 with Ruff for faster code linting.

#1123: Deprecate Prettier for code linting (pre-commit).

#1093: Option to override the “Create an issue” label per project.

#1092: Right sidebar scroll highlighting.

#1023: Added functionality to trigger documentation publications when updates are made to previous versions.

#1058: Added new button styles to the hero box.

#1059: Introduced an option to open topic boxes in the same tab.

#1069: Adds the option to exclude doctools.js per page to make the theme compatible with Swagger UI.

#972: Updated configuration to set myst_heading_anchors to 6 for compatibility purposes.

#1036: Made the project name in the sidebar clickable, enhancing navigation.

#1051: Improved the sidebar functionality to auto-scroll to the current page.

#1051: Adjusted the sidebar height to prevent the footer from overlapping

#1053: Discontinued Amplify support for page previews in favor of a custom Jenkins pipeline.

#949: Enhanced Zendesk verification tag support.

#962: pkg_resources is deprecated in favor of importlib.metadata.

#949: Separated global scripts from local scripts, allowing for customization of tags and scripts at the individual project level.

#891: Introduced parallel builds for enhanced performance.

#890: Implemented support for repositories utilizing Git Large File Storage (LFS).

#891: Upgraded to Sphinx 7.2.4, requiring Python 3.9 or higher for compatibility.

#867: Updated the header link to direct users to the most current open-source documentation site.

#827: Enhanced the guide on building multiversioned documentation locally.

#904: Fixed the style of admonitions with bullet points.

#889: Optimized top scroll padding, ensuring a similar behaviour across different component types.

#867: For Windows users: We have discontinued support for Git Bash, recommending users to transition to Windows Subsystem for Linux (WSL).

#912: The Windows-specific variables previously found in the docs/Makefile have been removed. Windows users are now advised to ensure that Poetry is added to the system’s PATH for seamless command execution and script running.

#781: The footer now includes an option to like or dislike the current page.

#803: Promote the use of MyST parser instead of recommonmark for new projects.

#764: The footer now links to ScyllaDB University.

#802: Upgraded certain icons to a higher resolution.

#803: The deployment process documentation was updated to use GitHub Actions.

#775: The sitemap links were not working properly.

#741: Option to skip custom theme warnings.

Add specific Google Tag Manager ID for the Scylla docs.

#652: The docs builds now raises a warning if a RST or MD file has underscores in the filename.

#696: The announcement banner can be managed from Google Tag Manager.

#720: In 1.3.5, we introduced a bug that caused some breadcrumbs to not have a link. This is now fixed.

#694: The sidebar highlights the current project you are viewing.

#694: The breadcrumbs now add a link to the root site docs.scylladb.com.

#694: The navigation bar links to the new enteprise docs site.

#646: The footer now adds a link to the community forum.

#651: The preference to keep the promotional banner closed now expires after 30 days.

#643: The “Edit this page” now opens default branch instead of the current branch of the docs you are viewing.

#647: Change “Scylla” occurrences to “ScyllaDB”.

#649: Remove the Scylla Cloud app from the header. Now the header only points to the Scylla Cloud docs.

#661: Maintainers can now add custom text after the content. This is useful for projects requiring a license notice on every documentation page.

#624: Label roles are now hidden on the right sidebar.

#590: Create a new “label” role to differenciate between enterprise and open-source features.

#599: Zendesk verification tag.

#555: Now the multiversion extension is mantained on this repository.

dependabot: We’ve updated all the JavaScript and Python dependencies to the latest version.

[#556]: Removed the _utils/deploy.sh script. Now the logic to deploy the docs is in the GitHub Actions workflow.

#525: When a user clicks on Create an issue button, the issue is now created with the prefix docs: and the label documentation.

#531: Adds instructions to trigger pull requests previews with Amplify only when there are updates within the docs folder.

We added a quickstart guide to create your first documentation page, list it in the table of contents, and preview the site locally.

#551: Adds an option to hide the multiversion selector for projects for projects that only build one version.

#509: We redesigned the home page search box to make it more visible.

#515: Before, redirects were part of the theme. This means that, for every version, the same redirects were being created, giving us little control if we wanted to redirect a page from the previous version to a different URL. Now, we are using a separate third-party package to create redirections. Also, instead of creating the same redirections for each version, we generate them at the end once the docs are built. This allows us to have better control of the redirects per version.

#533: We improved the build time of docs previews by 80%.

#536: The multiversion version dropdown is now always displayed, even if there is only one version.

#472: The hero box directive now can display the search box with a new option.

#452: Various improvements on the search page UI.

#447: We’ve replaced Netlify for AWS Amplify to automatically build pull requests previews for docs.

#406: Pages built with the make html builder were displaying an incorrect canonical URL.

#422: The theme generates a sitemap.xml by default.

#421: Show always contribute buttons.

#425: CSS for the 404 page was not loading.

#379: We’ve added Netlify support to automatically build pull requests previews for docs. This feature is in beta for a reduced number of projects.

#390: Once a week, a GitHub Action finds for broken links in Markdown and restructuredText files. If there are broken links, the action will create a new issue in the same repository with the links that have to be fixed.

#401: We’ve added new warning messages when previewing a non-stable version of the documentation.

#402: Now, you can create landing pages with sidebars.

#402: The theme includes a GitHub Action that runs the theme tests automatically when some of the theme files are edited.

#359: We’ve updated all the JavaScript and Python dependencies to the latest version.

#361: Tables were redesigned to make them more readable.

#371: We’ve moved the contribute buttons to the right sidebar.

#372: The substitutions extension is now installed as a third-party dependency.

#403: The theme does not show the multiversion dropdown in the sidebar if there is only one item.

#404: Now, topic box images are hidden in responsive view.

#410: We’ve improved the search component load time.

#357: The copy button displayed an empty circle on hover.

#362: The zoom option for images was only working with SVG images. Now, this feature is compatible with other formats such as PNG and JPG.

#382: When the top bar was closed, it continued appearing for milliseconds when the page was refreshed.

#389: We’ve increased the breadcrumbs spacing.

#406: Various pages shared the same canonical URL. Now, we point to the URL of the latest stable version of the document.

#344: Fixes the error TypeError: 'CQLLexer' object is not callable.

#323: The theme includes a new directive to collapse long content and redundant information.

#300 : Support for Sphinx 4.x.

#263: We use dependabot to receive automatic notifications when there are new dependency updates.

#229: New file-wide metadata options.

#263: Update JavaScript and Python dependencies to the latest version.

#307: Before, poetry was installed as a dependency. From this release, you must install Poetry as a prerequisite.

#301: Tables with headings were not styled.

#309: Expertrec added a new component for projects in the search box page. We’ve re-styled the page to match the theme’s look and feel.

#187: When a reader clicks on an image that has been resized, this now opens in full width.

#193: We’ve added a button to hide the sidebar. With this feature, our readers can read the documentation with fewer distractions.

#206: We’ve updated jQuery dependency to 3.6.0.

#246: The contribute button is more noticeable.

#247: The sidebar’s dropdown icons sport a new design.

#245: The panel box component sports a new design.

#252: We’ve reviewed the warning that appears when the user is not reading the latest stable version of the documentation. Now, the warning also considers branches that are still under active development.

#259: The sidebar’s scrollbar is now thinner and in line with the new design.

#213: We’ve added guides to help maintainers to migrate to ScyllaDB Sphinx Theme 1.0 and 1.1.

#236: Added documentation to install the toolchain for Windows users.

#214: Breadcrumbs now highlight the project’s name. With this change, readers will know which documentation site they are navigating.

#231: All external links include an external link icon, and they now open on a new page.

#240: We’ve removed transparency from the home page mascot.

#214: Breadcrumbs links to internal pages were not working.

#201: We’ve made a number of updates to the look and feel of the theme to improve the overall user experience.

#201: The static front end files (CSS, JS, and images) are now managed with webpack. For more information, see Contribute to the Theme.

#201: The promo banner now supports icons with the option theme option banner_icon_path. For more information, see Template Options.

#201: The contribute button adds the option “Edit on GitHub”. To configure your project to support this option, read Template Options.

#201: We run hooks on every commit to automatically point out linting issues.

#201: The new workflow docs-pr runs on pull requests to make sure docs build without warnings before being merged. For more information, see Deployment.

#201: Topics boxes (cards) can be used in other sections, and not just on the home page. We now have different layouts to suit most projects’ needs. Check them out at Topic Boxes

#201: We’ve added more unit tests to the project, especially to extensions.

#201: We’ve fixed JavaScript warnings and errors raised by the console.

#194: FontAwesome 5.0 backwards compatibility.

#180: Now projects can configure promotional banners.

#179: Troubleshooting guides for multiversion.

#173: Dropdown for Contributors with the options to “Report an Issue” and “Learn How to Contribute”.

#170: Option to hide versions from the multiversion dropdown.

#174: Shared substitutions for all projects.

#171: Branches name were rendered in ASC order.

#173: Report an issue button from footer.

#152: Top-bar for ScyllaDB University live.

#152: Top-bar for ScyllaDB University live.

#146: Guidelines for project maintainers.

#110: Theme option to override part of the version name in the multiversion dropdown.

#153: Create intermediate directories for redirections.

#121: smv_rename_latest_version setting in conf.py overrides the latest version output directory.

#121: Moved smv_latest_version from github/workflows/pages.yml to conf.py.

#121: _utils/redirects.sh script.

#121: make multiversionpreview was not redirecting automatically to the latest version.

#111: Show a warning if the latest version is not stable.

#106: Disable ScyllaDB Summit banner (#106).

#108: Documentation of the project moved under docs folder.

#98: Show Sphinx & Theme version in the footer.

#100: Show the multiversion label when there is only one version.

#103: Report button does not break when the page title has inlines.

#84: Banner for ScyllaDB Summit.

#95: Support for custom domain.

#92: Command to preview multiversion build.

#89: Rename the latest version URL automatically to stable.

#84: Banner for ScyllaDB Summit.

#83: Copyright year in the footer is now updated automatically.

#78: Show a warning when the user is not reading not reading the latest version.

#72: Overwrite the Sphinx classification for external and internal links.

#71: Site description is now configurable per project.

#65: External links and download links are now followed by an icon.

#53: Now code blocks can include substitutions.

#64: The 404 page sports a new design.

#69: Redirections on multiversion builds were not working

#68: PIPX dependency.

#59: All projects now share a 404 page.

#58: Support for redirections.