Skip to content

Commit 05860c1

Browse files
committed
meta: small improvements to docs (sequelize#17215)
1 parent b605bb3 commit 05860c1

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

CONTRIBUTING.DOCS.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
The sequelize documentation is divided in two parts:
44

55
- Tutorials, guides, and example based documentation are written in Markdown
6-
- The API reference is generated automatically from source code comments with [ESDoc](http://esdoc.org) (which uses [JSDoc](http://usejsdoc.org) syntax).
6+
- The API reference is generated automatically from source code comments and types with [TypeDoc](https://typedoc.org/).
77

8-
The whole documentation is rendered using ESDoc and continuously deployed to Github Pages at https://sequelize.org. The output is produced in the `esdoc` folder.
8+
The tutorials, written in markdown, are located at the [website repository](https://github.com/sequelize/website).
99

10-
The tutorials, written in markdown, are located in the `docs` folder. ESDoc is configured to find them in the `"manual"` field of `.esdoc.json`.
10+
To generate the API reference locally, run `yarn docs` and open the generated `.typedoc-build/index.html` in your favorite browser.
1111

12-
To generate the documentations locally, run `yarn docs` and open the generated `esdoc/index.html` in your favorite browser.
12+
The whole documentation is rendered using [Docusaurus](https://docusaurus.io/) and continuously deployed to https://sequelize.org. See the [website repository](https://github.com/sequelize/website) for more information.

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Learn to use [GitHub flavored markdown](https://help.github.com/articles/github-
2525

2626
### Opening an issue to report a bug
2727

28-
It is essential that you provide an [SSCCE](http://sscce.org/)/[MCVE](https://stackoverflow.com/help/minimal-reproducible-example) for your issue. You can use the [papb/sequelize-sscce](https://github.com/papb/sequelize-sscce) repository. Tell us what is the actual (incorrect) behavior and what should have happened (do not expect the maintainers to know what should happen!). Make sure you checked the bug persists in the latest Sequelize version.
28+
It is essential that you provide an [SSCCE](http://sscce.org/)/[MCVE](https://stackoverflow.com/help/minimal-reproducible-example) for your issue. You can use the [sequelize-sscce](https://github.com/sequelize/sequelize-sscce) repository. Tell us what is the actual (incorrect) behavior and what should have happened (do not expect the maintainers to know what should happen!). Make sure you checked the bug persists in the latest Sequelize version.
2929

3030
If you can even provide a Pull Request with a failing test (unit test or integration test), that is great! The bug will likely be fixed much faster in this case.
3131

@@ -67,7 +67,7 @@ A Pull Request is a request for maintainers to "pull" a specific change in code
6767

6868
Anyone can open a Pull Request, there is no need to ask for permission. Maintainers will look at your pull request and tell you if anything else must be done before it can be merged.
6969

70-
The target of the Pull Request should be the `main` branch (or in rare cases the `v5` branch, if previously agreed with a maintainer).
70+
The target of the Pull Request should be the `main` branch (or in rare cases the `v6` branch, if previously agreed with a maintainer).
7171

7272
Please check the _allow edits from maintainers_ box when opening it. Thank you in advance for any pull requests that you open!
7373

@@ -120,7 +120,7 @@ Once installed, run the `yarn build` command to build the project.
120120

121121
#### 2.1 Adding and updating dependencies
122122

123-
[Yarn v3](https://yarnpkg.com//) is used in the CI/CD pipeline so adding and updating dependencies must be done with Yarn.
123+
[Yarn v4](https://yarnpkg.com//) is used in the CI/CD pipeline so adding and updating dependencies must be done with Yarn.
124124

125125
#### 2.2 Running commands
126126

@@ -158,11 +158,11 @@ If you're happy to run tests only against an SQLite database, you can skip this
158158

159159
If you have Docker installed, use any of the following commands to start fresh local databases of the dialect of your choice:
160160

161-
- `yarn start-mariadb-oldest` (for MariaDB 10.4) or `yarn start-mariadb-latest` (for MariaDB 11.0)
161+
- `yarn start-mariadb-oldest` (for MariaDB 10.4) or `yarn start-mariadb-latest` (for MariaDB 11.3)
162162
- `yarn start-mysql-oldest` (for MySQL 8.0) or `yarn start-mysql-latest` (for MySQL 8.3)
163163
- `yarn start-postgres-oldest` (for Postgres 11) or `yarn start-postgres-latest` (for Postgres 15)
164164
- `yarn start-mssql-oldest` (for MSSQL 2017) or `yarn start-mssql-latest` (for MSSQL 2022)
165-
- `yarn start-db2-oldest` (for Db2 11.5.5.1) or `yarn start-db2-latest` (for Db2 11.5.8.0)
165+
- `yarn start-db2-oldest` (for Db2 11.5.5.1) or `yarn start-db2-latest` (for Db2 11.5.9.0)
166166

167167
_Note:_ if you're using Windows, make sure you run these from Git Bash (or another MinGW environment), since these commands will execute bash scripts. Recall that [it's very easy to include Git Bash as your default integrated terminal on Visual Studio Code](https://code.visualstudio.com/docs/editor/integrated-terminal).
168168

SECURITY.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
The following table describes the versions of this project that are currently supported with security updates:
66

7-
| Version | Supported |
8-
| ------- | ------------------ |
9-
| 6.x | :heavy_check_mark: |
10-
| 5.x | :heavy_check_mark: |
7+
| Version | Supported |
8+
| ----------- | ------------------ |
9+
| 7.x (alpha) | :heavy_check_mark: |
10+
| 6.x | :heavy_check_mark: |
1111

1212
## Responsible disclosure policy
1313

0 commit comments

Comments
 (0)