diff --git a/README.md b/README.md index 63f94efd..a19ab33c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ # skysql-docs -Repository for all SkySQL public documentation + +## Installation +To install the repository, follow these steps: +1. Clone the repository by running: `git clone git@github.com:skysqlinc/skysql-docs.git` + +## Local Debugging +### Using VS Code Markdown Extension +One option for local debugging is to use the VS Code Markdown extension. Please note that this method allows you to preview only the current page. + +### Using MkDocs +Another option is to use MkDocs for local debugging. Follow these steps: +1. Install MkDocs by running: `pip install mkdocs` +2. Install the MkDocs Material theme by running: `pip install mkdocs-material` +3. Serve the documentation locally by running: `mkdocs serve` + +## Development Practices +When making changes: +1. Create a new branch for your changes: `git checkout -b new-branch-name` +2. Test your changes locally. +3. Commit your changes: + - `git add .` + - `git commit -m "Your commit message"` +4. Push your changes to the remote repository: `git push origin new-branch-name` +5. Create a pull request for your changes to be reviewed and merged into the main branch. \ No newline at end of file diff --git a/docs/Data loading, Migration/Migrating your existing Production DB.md b/docs/Data loading, Migration/Migrating your existing Production DB.md index cf45c287..423e8230 100644 --- a/docs/Data loading, Migration/Migrating your existing Production DB.md +++ b/docs/Data loading, Migration/Migrating your existing Production DB.md @@ -82,7 +82,8 @@ To minimize downtime during migration, set up live replication from your source ```bash mysqldump -u [username] -p --all-databases --ignore-table=mysql.user \ - --routines --triggers --events --skip-lock-tables > dump.sql + --ignore-table=mysql.global_priv --routines --triggers --events \ + --skip-lock-tables > dump.sql ``` 3. **Dump the User Table Separately**: Since the `mysql.user` view aggregates information from the `global_priv` table, you should dump the `global_priv` table separately to ensure that user privileges are preserved: