Skip to content

properly fix links to configuration to take care of versioning/branches #271

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

Merged
tarzanek merged 1 commit into from
Dec 3, 2025
Merged

properly fix links to configuration to take care of versioning/branches #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions 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.

4 changes: 4 additions & 0 deletions docs/source/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,8 @@ The optional ``renames`` property lists the item columns to rename along the mig
to: <target-column-name>
# ... other columns to rename

.. _config-savepoints:

----------
Savepoints
----------
Expand Down Expand Up @@ -364,6 +366,8 @@ The ``validation`` field and its properties are mandatory only when the applicat
# What difference in ms should we allow between timestamps?
timestampMsTolerance: 0

.. _aws-authentication:

------------------
AWS Authentication
------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/migrate-from-cassandra-or-parquet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Migrate from Apache Cassandra or from a Parquet File
====================================================

This page explains how to fill the ``source`` and ``target`` properties of the `configuration file </configuration>`_ to migrate data:
This page explains how to fill the ``source`` and ``target`` properties of the :doc:`configuration file </configuration>` to migrate data:

- from Apache Cassandra, ScyllaDB, or from a `Parquet <https://parquet.apache.org/>`_ file,
- to Apache Cassandra or ScyllaDB.
Expand Down Expand Up @@ -124,7 +124,7 @@ In case the object is not public in the S3 bucket, you can provide the AWS crede

Where ``<access-key>`` and ``<secret-key>`` should be replaced with your actual AWS access key and secret key.

The Migrator also supports advanced AWS authentication options such as using `AssumeRole <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html>`_. Please read the `configuration reference </configuration#aws-authentication>`__ for more details.
The Migrator also supports advanced AWS authentication options such as using `AssumeRole <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html>`_. Please read the :ref:`configuration reference <aws-authentication>` for more details.

---------------------------
Configuring the Destination
Expand Down
8 changes: 4 additions & 4 deletions docs/source/migrate-from-dynamodb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Migrate from DynamoDB
=====================

This page explains how to fill the ``source`` and ``target`` properties of the `configuration file <../configuration>`_ to migrate data:
This page explains how to fill the ``source`` and ``target`` properties of the :doc:`configuration file </configuration>` to migrate data:

- from a DynamoDB table, a ScyllaDB Alternator table, or a `DynamoDB S3 export <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/S3DataExport.HowItWorks.html>`_,
- to a DynamoDB table or a ScyllaDB Alternator table.
Expand Down Expand Up @@ -57,7 +57,7 @@ In practice, your source database (DynamoDB or Alternator) may require authentic

Where ``<access-key>`` and ``<secret-key>`` should be replaced with your actual AWS access key and secret key.

The Migrator also supports advanced AWS authentication options such as using `AssumeRole <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html>`_. Please read the `configuration reference </configuration#aws-authentication>`__ for more details.
The Migrator also supports advanced AWS authentication options such as using `AssumeRole <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html>`_. Please read the :ref:`configuration reference <aws-authentication>` for more details.

Last, you can provide the following optional properties:

Expand Down Expand Up @@ -150,7 +150,7 @@ Additionally, you can provide the following optional properties:

Where ``<host>``, ``<port>``, ``<region>``, ``<access-key>``, and ``<secret-key>`` should be replaced with your specific values.

The Migrator also supports advanced AWS authentication options such as using `AssumeRole <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html>`_. Please read the `configuration reference </configuration#aws-authentication>`__ for more details.
The Migrator also supports advanced AWS authentication options such as using `AssumeRole <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html>`_. Please read the :ref:`configuration reference <aws-authentication>` for more details.

---------------------------
Configuring the Destination
Expand Down Expand Up @@ -209,4 +209,4 @@ Additionally, you can also set the following optional properties:

Where ``<host>``, ``<port>``, ``<region>``, ``<access-key>``, and ``<secret-key>`` are replaced with your specific values.

The Migrator also supports advanced AWS authentication options such as using `AssumeRole <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html>`_. Please read the `configuration reference </configuration#aws-authentication>`__ for more details.
The Migrator also supports advanced AWS authentication options such as using `AssumeRole <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html>`_. Please read the :ref:`configuration reference <aws-authentication>` for more details.
2 changes: 1 addition & 1 deletion docs/source/resume-interrupted-migration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ If, for some reason, the migration is interrupted (e.g., because of a networking

Savepoints are configuration files that contain information about the already migrated items, which can be skipped when the migration is resumed. The savepoint files are automatically generated during the migration. To use a savepoint, start a migration using it as configuration file.

You can control the savepoints location and the interval at which they are generated in the configuration file under the top-level property ``savepoints``. See `the corresponding section of the configuration reference </configuration#savepoints>`__.
You can control the savepoints location and the interval at which they are generated in the configuration file under the top-level property ``savepoints``. See the corresponding section of the configuration reference :ref:`configuration reference <config-savepoints>` .

During the migration, the savepoints are generated with file names like ``savepoint_xxx.yaml``, where ``xxx`` is a timestamp looking like ``1234567890``. To resume a migration, start a new migration with the latest savepoint as configuration file.