Add documentation structure

scylladb · Jun 26, 2024 · 995a019 · 995a019
1 parent 6dec14d
commit 995a019
Show file tree

Hide file tree

Showing 12 changed files with 57 additions and 8 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -109,7 +109,7 @@
     "hide_feedback_buttons": "false",
     "github_issues_repository": "scylladb/scylla-migrator",
     "github_repository": "scylladb/scylla-migrator",
-    "site_description": "Migrate data extract using Spark to Scylla, normally from Cassandra.",
+    "site_description": "Migrate data using Spark from Cassandra or DynamoDB to Scylla.",
     "hide_version_dropdown": [],
     "zendesk_tag": "",
     "versions_unstable": UNSTABLE_VERSIONS,

diff --git a/docs/source/getting-started/ansible.rst b/docs/source/getting-started/ansible.rst
@@ -0,0 +1,3 @@
+===================================
+Set Up a Spark Cluster with Ansible
+===================================
diff --git a/docs/source/getting-started/aws-emr.rst b/docs/source/getting-started/aws-emr.rst
@@ -0,0 +1,4 @@
+===================================
+Set Up a Spark Cluster with AWS EMR
+===================================
+
diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst
@@ -0,0 +1,10 @@
+===============
+Getting Started
+===============
+
+.. toctree::
+    :hidden:
+
+    ansible
+    aws-emr
+    spark-standalone
diff --git a/docs/source/getting-started/spark-standalone.rst b/docs/source/getting-started/spark-standalone.rst
@@ -0,0 +1,4 @@
+================================
+Manual Set Up of a Spark Cluster
+================================
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -2,9 +2,21 @@
 ScyllaDB Migrator Documentation
 ===============================
 
-Migrate data extract using Spark to Scylla, normally from Cassandra.
+The Scylla Migrator is a Spark application that migrates data to ScyllaDB. Its main features are the following:
+
+* it can read from Cassandra, Parquet, DynamoDB, or a DynamoDB S3 export
+* it can be distributed over multiple nodes of a Spark cluster to scale with your database cluster
+* it can rename columns along the way
+* it can transfer a snapshot of the source data, or continuously migrate new data as they come
+
+Read over the :doc:`Getting Started </getting-started/index>` page to set up a Spark cluster for a migration.
 
 .. toctree::
   :hidden:
 
-  sample-page
+  getting-started/index
+  migrate-from-cassandra-or-parquet
+  migrate-from-dynamodb
+  stream-changes
+  rename-columns
+  validate
diff --git a/docs/source/migrate-from-cassandra-or-parquet.rst b/docs/source/migrate-from-cassandra-or-parquet.rst
@@ -0,0 +1,5 @@
+=================================
+Migrate from Cassandra or Parquet
+=================================
+
+
diff --git a/docs/source/migrate-from-dynamodb.rst b/docs/source/migrate-from-dynamodb.rst
@@ -0,0 +1,5 @@
+=====================
+Migrate from DynamoDB
+=====================
+
+
diff --git a/docs/source/rename-columns.rst b/docs/source/rename-columns.rst
@@ -0,0 +1,5 @@
+==============
+Rename Columns
+==============
+
+
diff --git a/docs/source/sample-page.rst b/docs/source/sample-page.rst
diff --git a/docs/source/stream-changes.rst b/docs/source/stream-changes.rst
@@ -0,0 +1,3 @@
+==============
+Stream Changes
+==============
diff --git a/docs/source/validate.rst b/docs/source/validate.rst
@@ -0,0 +1,3 @@
+======================
+Validate the Migration
+======================