Skip to content

Commit

Permalink
Merge pull request #2326 from wellwelwel/docs-2
Browse files Browse the repository at this point in the history
chore: remove duplicate documentation and examples
  • Loading branch information
wellwelwel authored Dec 31, 2023
2 parents 21860e0 + eeac765 commit 50b40a5
Show file tree
Hide file tree
Showing 51 changed files with 26 additions and 2,605 deletions.
4 changes: 4 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ updates:
directory: "/"
schedule:
interval: "daily"
- package-ecosystem: "npm"
directory: "/website"
schedule:
interval: "weekly"
2 changes: 1 addition & 1 deletion .github/workflows/benchmark.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
- uses: actions/checkout@v2

# - name: Set up MySQL
# run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_ROOT_PASSWORD=${{ env.MYSQL_PASSWORD }} -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/examples/custom-conf:/etc/mysql/conf.d -v $PWD/examples/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}
# run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_ROOT_PASSWORD=${{ env.MYSQL_PASSWORD }} -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/test/fixtures/custom-conf:/etc/mysql/conf.d -v $PWD/test/fixtures/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}
- name: Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-bun.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Set up MySQL
run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/examples/custom-conf:/etc/mysql/conf.d -v $PWD/examples/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}
run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/test/fixtures/custom-conf:/etc/mysql/conf.d -v $PWD/test/fixtures/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}

- name: Set up Bun ${{ matrix.bun-version }}
uses: oven-sh/setup-bun@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ jobs:

- name: Set up MySQL
if: ${{ matrix.mysql-version }}
run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/examples/custom-conf:/etc/mysql/conf.d -v $PWD/examples/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}
run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/test/fixtures/custom-conf:/etc/mysql/conf.d -v $PWD/test/fixtures/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}

- name: Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
[![Windows Build][appveyor-image]][appveyor-url]
[![License][license-image]][license-url]

English | [简体中文](./documentation/zh-cn/) | [Português (BR)](./documentation/pt-br/)
English | [简体中文](https://sidorares.github.io/node-mysql2/zh-CN/docs) | [Português (BR)](https://sidorares.github.io/node-mysql2/pt-BR/docs)

> MySQL client for Node.js with focus on performance. Supports prepared statements, non-utf8 encodings, binary log protocol, compression, ssl [much more](./documentation/en).
> MySQL client for Node.js with focus on performance. Supports prepared statements, non-utf8 encodings, binary log protocol, compression, ssl [much more](https://sidorares.github.io/node-mysql2/docs).
__Table of contents__

Expand All @@ -35,14 +35,14 @@ MySQL2 project is a continuation of [MySQL-Native][mysql-native]. Protocol parse
MySQL2 is mostly API compatible with [mysqljs][node-mysql] and supports majority of features. MySQL2 also offers these additional features:

- Faster / Better Performance
- [Prepared Statements](./documentation/en/Prepared-Statements.md)
- [Prepared Statements](https://sidorares.github.io/node-mysql2/docs/documentation/prepared-statements)
- MySQL Binary Log Protocol
- [MySQL Server](./documentation/en/MySQL-Server.md)
- [MySQL Server](https://sidorares.github.io/node-mysql2/docs/documentation/mysql-server)
- Extended support for Encoding and Collation
- [Promise Wrapper](./documentation/en/Promise-Wrapper.md)
- [Promise Wrapper](https://sidorares.github.io/node-mysql2/docs/documentation/promise-wrapper)
- Compression
- SSL and [Authentication Switch](./documentation/en/Authentication-Switch.md)
- [Custom Streams](./documentation/en/Extras.md)
- SSL and [Authentication Switch](https://sidorares.github.io/node-mysql2/docs/documentation/authentication-switch)
- [Custom Streams](https://sidorares.github.io/node-mysql2/docs/documentation/extras)
- [Pooling](#using-connection-pools)

## Installation
Expand All @@ -59,7 +59,7 @@ If you are using TypeScript, you will need to install `@types/node`.
npm install --save-dev @types/node
```

> For TypeScript documentation and examples, see [here](./documentation/en/TypeScript-Examples.md).
> For TypeScript documentation and examples, see [here](https://sidorares.github.io/node-mysql2/docs/documentation/typescript-examples).
## First Query
```js
Expand Down Expand Up @@ -262,7 +262,7 @@ If you find any other incompatibility with [Node MySQL][node-mysql], Please repo

## Documentation

You can find more detailed documentation [here](./documentation/en). You should also check various code [examples](./examples) to understand advanced concepts.
You can find more detailed documentation [here](https://sidorares.github.io/node-mysql2/docs/documentation). You should also check various code [examples](https://sidorares.github.io/node-mysql2/docs/examples) to understand advanced concepts.

## Acknowledgements

Expand Down
109 changes: 0 additions & 109 deletions documentation/en/Authentication-Switch.md

This file was deleted.

115 changes: 0 additions & 115 deletions documentation/en/Examples.md

This file was deleted.

Loading

0 comments on commit 50b40a5

Please sign in to comment.