This repository contains the source files for the DataStax Zero Downtime Migration documentation.
The documentation is written in AsciiDoc-formatted source files located in the modules
directory.
For simple updates like fixing typos or modifying existing prose, it’s easiest to edit the source files directly on GitHub.
ℹ️
|
You’ll need Write privileges on the repository to edit files directly on GitHub. |
-
Find the file you want to edit in the
modules
directory. -
Click the Edit icon in the upper-right corner of the file view.
-
Make your changes in the editor.
-
Click Commit changes…
-
Enter a description for your commit and click Propose changes.
-
On the Open a pull request screen, enter a title and description for your change, assign reviewers, then click Create pull request.
-
Once the pull request is open, an automatic draft preview build is triggered. Once complete, the build system posts a comment on the pull request with a link to the draft site for you to preview your changes.
If you need to make substantial updates to the documentation, you’ll want to clone the repository so you can work with the source files locally.
-
Clone this repository
git clone https://github.com/datastax/migration-docs.git
-
Create a classic personal access token for your GitHub account. When configuring the token, set the Expiration to at least 90 days and select everything under the Repo scope.
❗Copy your personal access token to a temporary location — you’ll need it later.
-
Authorize your personal access token so that it can access repositories in the Riptano and DataStax organizations in GitHub.
-
Populate the credential store with your personal access token. For most people this means doing the following:
-
Create the file
$HOME/.git-credentials
and open it in your editor. -
Add the following line:
https://TOKEN:@github.com
Replace
TOKEN
with the personal access token you copied from GitHub. -
Save and close the file.
-
-
If you don’t already have Node.js installed, do the following:
-
Install the project dependencies.
cd migration-docs
npm install
-
Build the site.
npm run build:local
If the build was successful, you’ll see the following output in your terminal:
Site generation complete! Open file:https:///Users/USERNAME/repos/migration-docs/build/site/index.html in a browser to view your site.
To view the site, paste the entire
file:https:///
path into your browser’s address bar and press Return.
To learn how to publish documentation to docs.datastax.com, see the datastax-docs-site README.