Merge branch 'main' into new-loader

scylladb · Feb 19, 2025 · cc0c739 · cc0c739
2 parents 362ad2e + 03394f3
commit cc0c739
Show file tree

Hide file tree

Showing 10 changed files with 1,308 additions and 46 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/docs"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-name: "sphinx-scylladb-theme"
+      - dependency-name: "sphinx-multiversion-scylla"
diff --git a/.github/workflows/docs-amplify-enhanced.yaml b/.github/workflows/docs-amplify-enhanced.yaml
diff --git a/.github/workflows/docs-pages.yaml b/.github/workflows/docs-pages.yaml
@@ -8,6 +8,7 @@ on:
       - main
     paths:
       - "docs/**"
+      - 'branch-**'
   workflow_dispatch:
 
 jobs:
@@ -17,13 +18,14 @@ jobs:
       - name: Checkout
         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@v4
         with:
-          python-version: 3.7
+          python-version: '3.10'
 
       - name: Set up env
         run: make -C docs setupenv

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,2 @@
+.doctrees
+_build
diff --git a/docs/Makefile b/docs/Makefile
@@ -24,6 +24,9 @@ setupenv:
 .PHONY: setup
 setup:
 	$(POETRY) install
+
+.PHONY: update
+update:
 	$(POETRY) update
 
 # Clean commands
@@ -34,7 +37,6 @@ pristine: clean
 .PHONY: clean
 clean:
 	rm -rf $(BUILDDIR)/*
-	rm -f poetry.lock
 
 # Generate output commands
 .PHONY: dirhtml

diff --git a/docs/poetry.lock b/docs/poetry.lock
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -3,19 +3,19 @@ name = "sphinx-docs"
 description = "ScyllaDB Documentation"
 version = "0.1.0"
 authors = ["ScyllaDB Documentation Contributors"]
+package-mode = false
 
 [tool.poetry.dependencies]
-python = "^3.9"
-pyyaml = "6.0.1"
-pygments = "2.15.1"
-recommonmark = "0.7.1"
-sphinx-scylladb-theme = "~1.6.1"
-sphinx-autobuild = "2021.3.14"
-Sphinx = "7.2.6"
-sphinx-multiversion-scylla = "~0.3.1"
-sphinx-sitemap = "2.5.1"
-redirects_cli ="~0.1.3"
+python = "^3.10"
+pygments = "^2.18.0"
+myst-parser = "^3.0.1"
+sphinx-scylladb-theme = "^1.8.1"
+sphinx-autobuild = "^2024.4.19"
+Sphinx = "^7.3.7"
+sphinx-multiversion-scylla = "^0.3.1"
+sphinx-sitemap = "^2.6.0"
+redirects_cli ="^0.1.3"
 
 [build-system]
-requires = ["poetry>=0.12"]
+requires = ["poetry>=1.8.0"]
 build-backend = "poetry.masonry.api"
diff --git a/docs/source/_static/img/scylla-cloud-mascot.png b/docs/source/_static/img/scylla-cloud-mascot.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -34,7 +34,7 @@
     "sphinx_sitemap",
     "sphinx_scylladb_theme",
     "sphinx_multiversion",  # optional
-    "recommonmark",  # optional
+    "myst_parser",  # optional
 ]
 
 # The suffix(es) of source filenames.
@@ -60,6 +60,10 @@
 .. |rst| replace:: restructuredText
 """
 
+# -- Options for myst parser ----------------------------------------
+myst_enable_extensions = ["colon_fence"]
+
+
 # -- Options for not found extension
 
 # Template used to render the 404.html generated by this extension.
@@ -110,6 +114,7 @@
     "github_repository": "scylladb/video-streaming",
     "site_description": "ScyllaDB video streaming sample app",
     "hide_version_dropdown": ["main"],
+    "hide_versions_dropdown": "true",
     "versions_unstable": UNSTABLE_VERSIONS,
     "versions_deprecated": DEPRECATED_VERSIONS,
 }

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,37 +1,37 @@
 :full-width:
+:landing:
 :hide-sidebar:
 :hide-secondary-sidebar:
 :hide-version-warning:
 :hide-pre-content:
 :hide-post-content:
-:landing:
 
 .. title:: 1 million ops/sec Terraform demo
 
 .. hero-box::
   :title: 1 million ops/sec ScyllaDB demos with Terraform
-  :image: /_static/img/scylla-cloud-mascot.png
-  :button_icon: fa fa-github
+  :image: /_static/img/mascots-2/cloud.svg
+  :button_icon: icon-github
+  :button_style: bold
   :button_url: https://github.com/scylladb/1m-ops-demo
-  :button_text: GitHub repository
+  :button_text: Source code
 
   Test and benchmark ScyllaDB under a 1 million operations per second workload.
 
 .. raw:: html
 
-  <div class="landing__content landing__content">
+  <div class="landing__content">
 
 .. raw:: html
 
   <div class="topics-grid grid-container full">
 
   <div class="grid-x grid-margin-x">
 
-
 .. topic-box::
   :title: ScyllaDB Cloud 1M ops/sec
   :link: getting-started
-  :icon: scylla-icon scylla-icon--getting-started
+  :icon: icon-cloud
   :class: large-4
   :anchor: Get started
 
@@ -40,16 +40,15 @@
 .. topic-box::
   :title: ScyllaDB Enterprise 1M ops/sec
   :link: getting-started-enterprise
-  :icon: scylla-icon scylla-icon--getting-started
+  :icon: icon-instance
   :class: large-4
   :anchor: Get started
 
   Set up 1 million operations/second demo with ScyllaDB Enterprise
 
-
 .. topic-box::
   :title: Set Up Your Own 1M OPS Benchmark - blog
-  :icon: scylla-icon scylla-icon--blog
+  :icon: icon-edit
   :link: https://www.scylladb.com/2023/11/29/set-up-your-own-1m-ops-benchmark-with-scylladb-cloud-terraform
   :class: large-4,small-12
   :anchor: Read the article
@@ -68,8 +67,3 @@
    Getting started with Enterprise <getting-started-enterprise>
    Blogpost - Set Up Your Own 1M OPS Benchmark <https://www.scylladb.com/2023/11/29/set-up-your-own-1m-ops-benchmark-with-scylladb-cloud-terraform/>
    GitHub repository <https://github.com/scylladb/1m-ops-demo>
-
-
-
-
-