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.

Sign up for GitHub

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: render supported enterprise versions from json #29

Merged
merged 2 commits into from
Nov 25, 2024
Merged

docs: render supported enterprise versions from json #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
848d4bd
docs: render supported enterprise versions from json
dgarcia360 Nov 19, 2024
8650f14
docs: add policy-link as flag
dgarcia360 Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/_static/data/enterprise_supported_versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"data": [
{
"version": "2024.2",
"released": "November 2024",
"status": "Supported",
"end_of_life": "After 2026.1 or 2025.2 is released",
"show_version_policy_link": true
},
{
"version": "2024.1 (LTS)",
"released": "February 2024",
"status": "Supported",
"end_of_life": "After 2026.1 is released",
"show_version_policy_link": true
},
{
"version": "2023.1 (LTS)",
"released": "August 2023",
"status": "Supported",
"end_of_life": "After 2025.1 is released",
"show_version_policy_link": true
},
{
"version": "2022.2",
"released": "January 2023",
"status": "Not supported",
"end_of_life": "June 2024",
"show_version_policy_link": false
},
{
"version": "2022.1 (LTS)",
"released": "August 2022",
"status": "Not supported",
"end_of_life": "June 2024",
"show_version_policy_link": false
}
]
}
15 changes: 15 additions & 0 deletions docs/_templates/supported_versions.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. list-table::
:widths: 20 25 20 35
:header-rows: 1

* - Version
- Released
- Status
- End of Life (EOL)

{% for row in data['data'] %}
* - {{ row['version'] }}
- {{ row['released'] }}
- {{ row['status'] }}
- {{ row['end_of_life'] }} {% if row['show_version_policy_link'] %} (see :ref:`Version Support Policy <version-support-policy>`){% endif %}
{% endfor %}
5 changes: 5 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@
"sphinx_sitemap",
"sphinx_scylladb_theme",
"sphinx_multiversion", # optional
"sphinxcontrib.datatemplates",

]

# The suffix(es) of source filenames.
Expand Down Expand Up @@ -94,6 +96,9 @@
# The theme to use for pages.
html_theme = "sphinx_scylladb_theme"

# The directory for data templates.
templates_path = ['_templates', ]

# These folders are copied to the documentation's HTML output
html_static_path = ['_static']

Expand Down
52 changes: 51 additions & 1 deletion docs/poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ sphinx-autobuild = "^2024.4.19"
Sphinx = "^7.3.7"
sphinx-multiversion-scylla = "^0.3.1"
redirects_cli ="^0.1.3"
sphinxcontrib-datatemplates = "^0.11.0"

[build-system]
requires = ["poetry>=1.8.0"]
Expand Down
30 changes: 2 additions & 28 deletions docs/versioning/version-support-enterprise.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,8 @@ ScyllaDB Enterprise Version Support
Supported Versions
------------------------

.. list-table::
:widths: 20 25 20 35
:header-rows: 1

* - Version
- Released
- Status
- End of Life (EOL)
* - 2024.2
- November 2024
- Supported
- After 2026.1 or 2025.2 is released (see :ref:`Version Support Policy <version-support-policy>`)
* - 2024.1 (LTS)
- February 2024
- Supported
- After 2026.1 is released (see :ref:`Version Support Policy <version-support-policy>`)
* - 2023.1 (LTS)
- August 2023
- Supported
- After 2025.1 is released (see :ref:`Version Support Policy <version-support-policy>`)
* - 2022.2
- January 2023
- Not supported
- June 2024
* - 2022.1 (LTS)
- August 2022
- Not supported
- June 2024
.. datatemplate:json:: /_static/data/enterprise_supported_versions.json
:template: supported_versions.tmpl

Version Numbering
-------------------
Expand Down