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

[DOCS] Salt Reference Docs: Sphinx Theme Refresh (Furo, Sphinx Book, or Alternative Third-Party Managed Theme) and Deprecation of saltstack2 custom theme #67090

Open
ScriptAutomate opened this issue Dec 6, 2024 · 0 comments
Labels
Documentation Relates to Salt documentation needs-triage

Comments

@ScriptAutomate
Copy link
Contributor

ScriptAutomate commented Dec 6, 2024

Description

The saltstack2 Sphinx theme is fairly out-dated and in need of updates and better maintainership if wanting to continue to be used over time.

Suggested Fix

Salt Project should migrate to a new theme that is maintained by a larger community, such as Furo (which is currently used by Salt Install Guide, Salt User Guide, and many official Python projects throughout the Python community), or Sphinx Book Theme (which is maintained by ExecutableBooks, and may have missing features and expanded support that furo doesn't currently have).

If looking to Sphinx Book, should look at migrating the docs using Furo also over to the same theme, for a unified experience.

Type of documentation

Salt Project reference docs

Location or format of documentation

Source of reference docs theme in this repo:

The published reference docs are found here:

The other published docs using furo can be found here:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation needs-triage
Projects
None yet
Development

No branches or pull requests

1 participant