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 landing & theme to 1.7 #14

Merged
merged 1 commit into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 6 additions & 4 deletions .github/workflows/docs-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ name: "Docs / Publish"
on:
push:
branches:
- 'main'
- main
- 'branch-**'
paths:
- "docs/**"
workflow_dispatch:
Expand All @@ -15,14 +16,15 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
ref: ${{ github.event.repository.default_branch }}
persist-credentials: false
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v3
uses: actions/setup-python@v5
with:
python-version: 3.7
python-version: '3.10'
- name: Set up env
run: make -C docs setupenv
- name: Build docs
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/docs-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
persist-credentials: false
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: 3.7
python-version: '3.10'

- name: Set up env
run: make -C docs setupenv
Expand Down
16 changes: 14 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@
.. hero-box::
:title: Welcome to ScyllaDB Documentation
:image: /_static/img/mascots/scylla-docs.svg
:button_icon: fa fa-play
:button_icon: fa fa-arrow-right
:button_url: https://docs.scylladb.com/stable/get-started/
:button_text: New to ScyllaDB? Start here!
:button_text: New to ScyllaDB?
:button_style: bold
:button_icon_position: right
:button_icon_link:
:cta: Start here!

.. raw:: html

Expand All @@ -29,6 +33,7 @@
:title: ScyllaDB Cloud
:icon: scylla-icon scylla-icon--cloud
:link: https://cloud.docs.scylladb.com
:link_target: _self
:class: large-4 cloud-card
:anchor: ScyllaDB Cloud Documentation

Expand All @@ -38,6 +43,7 @@
:title: ScyllaDB Enterprise
:icon: scylla-icon scylla-icon--enterprise-m
:link: https://enterprise.docs.scylladb.com
:link_target: _self
:class: large-4 enterprise-card
:anchor: ScyllaDB Enterprise Documentation

Expand All @@ -47,6 +53,7 @@
:title: ScyllaDB Open Source
:icon: scylla-icon scylla-icon--about-us-m
:link: https://opensource.docs.scylladb.com
:link_target: _self
:class: large-4 opensource-card
:anchor: ScyllaDB Open Source Documentation

Expand All @@ -70,6 +77,7 @@
.. topic-box::
:title: ScyllaDB Alternator
:link: https://opensource.docs.scylladb.com/stable/alternator/alternator.html
:link_target: _self
:image: /_static/img/mascots/scylla-alternator.svg
:class: topic-box--product,large-4,small-6

Expand All @@ -78,6 +86,7 @@
.. topic-box::
:title: ScyllaDB Monitoring Stack
:link: https://monitoring.docs.scylladb.com
:link_target: _self
:image: /_static/img/mascots/scylla-monitor.svg
:class: topic-box--product,large-4,small-6

Expand All @@ -86,6 +95,7 @@
.. topic-box::
:title: ScyllaDB Manager
:link: https://manager.docs.scylladb.com
:link_target: _self
:image: /_static/img/mascots/scylla-manager.svg
:class: topic-box--product,large-4,small-6

Expand All @@ -94,6 +104,7 @@
.. topic-box::
:title: ScyllaDB Drivers
:link: https://opensource.docs.scylladb.com/stable/using-scylla/drivers/
:link_target: _self
:image: /_static/img/mascots/scylla-drivers.svg
:class: topic-box--product,large-4,small-6

Expand All @@ -102,6 +113,7 @@
.. topic-box::
:title: ScyllaDB Operator
:link: https://operator.docs.scylladb.com
:link_target: _self
:image: /_static/img/mascots/scylla-enterprise.svg
:class: topic-box--product,large-4,small-6

Expand Down
2 changes: 1 addition & 1 deletion docs/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ authors = ["ScyllaDB Contributors"]
python = "^3.9"
pyyaml = "6.0.1"
pygments = "2.15.1"
sphinx-scylladb-theme = "~1.6.1"
sphinx-scylladb-theme = "^1.7.1"
sphinx-sitemap = "2.5.1"
sphinx-autobuild = "2021.3.14"
Sphinx = "7.2.6"
Expand Down