-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41 from skysqlinc/readme
adding mysql.global_priv to the mysqldump exclusion list
- Loading branch information
Showing
2 changed files
with
26 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters