From 7855f2687efe6d0aaafa9f5f15b304982cc11c6f Mon Sep 17 00:00:00 2001 From: David Garcia Date: Fri, 12 Apr 2024 17:06:12 +0100 Subject: [PATCH] Update landing & theme to 1.7 --- .github/workflows/docs-pages.yaml | 10 ++++++---- .github/workflows/docs-pr.yaml | 6 +++--- docs/index.rst | 16 ++++++++++++++-- docs/pyproject.toml | 2 +- 4 files changed, 24 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs-pages.yaml b/.github/workflows/docs-pages.yaml index 632746aee..902b01e98 100644 --- a/.github/workflows/docs-pages.yaml +++ b/.github/workflows/docs-pages.yaml @@ -5,7 +5,8 @@ name: "Docs / Publish" on: push: branches: - - 'main' + - main + - 'branch-**' paths: - "docs/**" workflow_dispatch: @@ -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 diff --git a/.github/workflows/docs-pr.yaml b/.github/workflows/docs-pr.yaml index 0784cb11a..f27350e5b 100644 --- a/.github/workflows/docs-pr.yaml +++ b/.github/workflows/docs-pr.yaml @@ -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 diff --git a/docs/index.rst b/docs/index.rst index a5820cea4..82eb49515 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/docs/pyproject.toml b/docs/pyproject.toml index b672a80d6..2419cfbea 100644 --- a/docs/pyproject.toml +++ b/docs/pyproject.toml @@ -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"