Skip to content

Commit 27a45d1

Browse files
derrickmehaffyazulkiplialexkainzingerGeoFropwizla
authored
Very late Dec deploy (#629)
* auth route v4 (#553) i found that default authentication route should be `/api/auth/local` * fix: typo in backend-customization/middlewares.md (#557) * Update i18n.md (#564) Co-authored-by: Pierre Wizla <[email protected]> * Added API suffix (#556) Co-authored-by: Pierre Wizla <[email protected]> * fix wrong uid (#558) Signed-off-by: harimkims <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * default route user register in v4 (#554) I found that default route user register in v4 is `api/auth/local/register` Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Fix remaining localhost links (#568) * Fix wrong syntax in GraphQL plugin docs (#537) Signed-off-by: harimkims <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Fix wrong parameter name in connection.connection (#559) In the documentation about the connection parameters, the `username` parameter does not actually exist. This is probably a typo and should be replaced by the `user` parameter as per the example given below on the same page. Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Fix broken links in GraphQL & i18n (#583) * Update default MySQL Port (#575) Update default MySQL Port in example to 3306 Co-authored-by: Pierre Wizla <[email protected]> * Add closing parenthesis to predefined hook code example (#589) * 📖 ⬆️ bump Mysql/MariaDB minimum verison (#593) - bump MyQL/MariaDB Minimum Version for `JSON` datatype support * Update controllers.md (#586) There should be two enclosing parenthesis at the end. Co-authored-by: Pierre Wizla <[email protected]> * Fix config example for GraphQL (#591) Co-authored-by: Pierre Wizla <[email protected]> * docs: One-to-One should use singular in example (#570) Co-authored-by: Pierre Wizla <[email protected]> * Remaining auth v4 changes (#565) There are still some references to the v3 auth endpoints (without `/api` at the start) on the Users and Permissions plugin documentation. # What does it do? Updates Strapi endpoints to include `/api` at the start # Why is it needed? This change should be documented; it caused a lot of confusion for me as I was trying to figure out why my authentication was not working on v4. # Related issue(s)/PR(s) A similar thing was fixed for the guides in PR #553 Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: DMehaffy <[email protected]> * lifecycles.js file is not generated automatically (#566) * lifecycles.js file is not generated automatically I think since version 4, the lifecycles.js file is not created automatically but needs to be created manually, if needed. Postscript Correct me if I'm wrong. You can also rephrase this change if it is relevant and true. Thanks * Update docs/developer-docs/latest/development/backend-customization/models.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/development/backend-customization/models.md Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Rewrite REST examples to use QS + Misc fixes (#541) * WIP rewriting REST guide * Fix example * rewrite filtering and init the other two * move to request/response instead * remove an example and fix typo * remove another example based on community feedback * add missing $and and $or * 99% finished with filtering * wip population * Try adding some GitHub Actions to check links * fix syntax error in tests file * Force working directory * change to only pull request * Fix publicationState and add field selection * Add relation population examples * Add component exmple * basic dynamic zone example, need a more complex one too Need to talk to engineering about more complex example * Finished rewriting REST docs Just need to clean up left menu * Fix broken links * Fix missing commas in examples * Fix all non-uniform uses of `// ...` Yes I was bored af * fix example response syntax error * Fix extra data comments * remove workflow from this PR move to #574 * pr feedback 1 * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md Co-authored-by: Pierre Wizla <[email protected]> * Apply suggestions from code review Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md Co-authored-by: Pierre Wizla <[email protected]> * tweak menu + other fixes Co-authored-by: Pierre Wizla <[email protected]> * Corrected: Database.js Structure and key variable (#603) The default structure provided in the doc doesn't work on AWS. The provided syntax which has connection object within connection object which consists of configurations seems to work. username key is being replaced with user * Change strapi.api example from function to array (#539) * Add information about uid and remove model name for upload ref (#614) * Update server.md (#598) * Update i18n docs, fix locale filter typo + autoformat (#609) * Update email.md (#611) Link to correct sendgrid npm * Fix wrong strapi module name for server.js (#615) Signed-off-by: harimkims <[email protected]> * easy syntax corrections in entity-service/crud (#620) * easy syntax correction. should be api:: with double colon * fix typo in entity service example * fix some of the broken links (#626) * Fix typo in configuration options (#619) Configuration options for toggling tutorials on or off and notifying about new releases contained a typo referencing "tutorial" key instead of "tutorials" and "notification.release" instead of "notification.releases" * entityService/populate updates to v4 (#621) * entityService is not function * add await to entityService * some changes entity-service/populate * Update entity-service/populate.md Co-authored-by: DMehaffy <[email protected]> * Update populate.md Co-authored-by: DMehaffy <[email protected]> * typos (#628) * Update upload.md (#616) Typo in "middleware" Co-authored-by: azulkipli <[email protected]> Co-authored-by: Alexander Kainzinger <[email protected]> Co-authored-by: George F <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Precious Luke <[email protected]> Co-authored-by: Kim, Harim <[email protected]> Co-authored-by: Camille Briand <[email protected]> Co-authored-by: Adam Miedema <[email protected]> Co-authored-by: YoRolling <[email protected]> Co-authored-by: Zeeshan Tariq <[email protected]> Co-authored-by: smoothdvd <[email protected]> Co-authored-by: arielbk <[email protected]> Co-authored-by: Adiel Ben Moshe <[email protected]> Co-authored-by: Shubam Virdi <[email protected]> Co-authored-by: cvermand <[email protected]> Co-authored-by: Richard Nsama <[email protected]> Co-authored-by: Stefano <[email protected]> Co-authored-by: Jean-Sébastien Herbaux <[email protected]> Co-authored-by: Francesco Bianchi <[email protected]> Co-authored-by: Sharsie <[email protected]> Co-authored-by: sunnyson <[email protected]> Co-authored-by: Jozef Culen <[email protected]>
1 parent f6db32a commit 27a45d1

File tree

18 files changed

+68
-79
lines changed

18 files changed

+68
-79
lines changed

‎docs/.vuepress/config.js‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ const sidebar = {
112112
},
113113
{
114114
title: 'Deployment',
115-
path: '/developer-docs/latest/setup-deployment-guides/deployment',
115+
path: '/developer-docs/latest/setup-deployment-guides/deployment.html',
116116
collapsable: true,
117117
initialOpenGroupIndex: -1, // make sure that no subgroup is open by default — if set to 0, 'Hosting Provider Guides' is expanded
118118
children: [
@@ -193,7 +193,7 @@ const sidebar = {
193193
{
194194
title: 'Back-end customization',
195195
collapsable: true,
196-
path: '/developer-docs/latest/development/backend-customization',
196+
path: '/developer-docs/latest/development/backend-customization.html',
197197
children: [
198198
['/developer-docs/latest/development/backend-customization/routes.md', 'Routes'],
199199
['/developer-docs/latest/development/backend-customization/policies.md', 'Policies'],
@@ -299,7 +299,7 @@ const sidebar = {
299299
{
300300
title: 'Entity Service API',
301301
path:
302-
'/developer-docs/latest/developer-resources/database-apis-reference/entity-service-api',
302+
'/developer-docs/latest/developer-resources/database-apis-reference/entity-service-api.html',
303303
collapsable: true,
304304
children: [
305305
[
@@ -814,21 +814,21 @@ module.exports = {
814814
text: 'Setup & Deployment',
815815
link: '/developer-docs/latest/setup-deployment-guides/installation.html',
816816
},
817-
{
818-
text: 'Plugins',
819-
link: '/developer-docs/latest/plugins/plugins-intro.html',
820-
},
821817
{
822818
text: 'Development',
823819
link: '/developer-docs/latest/development/backend-customization.html',
824820
},
825821
{
826-
text: 'Update & Migration',
827-
link: '/developer-docs/latest/update-migration-guides/update-version.html',
822+
text: 'Developer Resources',
823+
link: '/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html',
828824
},
829825
{
830-
text: 'Developer Resources',
831-
link: '/developer-docs/latest/developer-resources/content-api/content-api.html',
826+
text: 'Plugins',
827+
link: '/developer-docs/latest/plugins/plugins-intro.html',
828+
},
829+
{
830+
text: 'Update & Migration',
831+
link: '/developer-docs/latest/update-migration-guides/update-version.html',
832832
},
833833
],
834834
},
@@ -874,7 +874,7 @@ module.exports = {
874874
],
875875
},
876876
{
877-
text: 'v3 documentation',
877+
text: 'v3 Documentation',
878878
link: 'https://docs-v3.strapi.io'
879879
},
880880
{

‎docs/developer-docs/latest/concepts/draft-and-publish.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ The draft and publish feature allows you to save your content as a draft, to pub
1010

1111
## Activating or deactivating the draft and publish feature
1212

13-
By default, the draft and publish feature is activated for all newly created collection and single types. It is however possible to deactive the feature at content type level (i.e. it can be activated for one content type, but deactivated for another).
13+
By default, the draft and publish feature is activated for all newly created collection and single types. It is however possible to deactivate the feature at content type level (i.e. it can be activated for one content type, but deactivated for another).
1414

1515
::: warning
1616
If the feature is deactivated while contents are saved as drafts, they will automatically be deleted. Make sure all contents are published before deactivating the feature.
1717
:::
1818

1919
To deactivate the draft and publish feature for a content type:
2020

21-
1. Go the Plugins > Content-Type Builder.
21+
1. Go to the Plugins > Content-Type Builder.
2222
2. Select the collection or single type for which you want the draft and publish feature to be deactivated.
2323
3. Click on the Edit <Fa-PencilAlt /> button to access the content type's configurations.
2424
4. Click on the "Advanced Settings" tab.

‎docs/developer-docs/latest/developer-resources/cli/CLI.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ You should never use this command to run a Strapi application in production.
6767

6868
Start a Strapi application with autoReload disabled.
6969

70-
This commands is there to run a Strapi application without restarts and file writes (aimed at production usage).
70+
This command is there to run a Strapi application without restarts and file writes (aimed at production usage).
7171
Certain features are disabled in the `strapi start` mode because they require application restarts.
7272

7373
Allowed environment variables:
@@ -177,7 +177,7 @@ When running the restore command, you can choose from three different strategies
177177
**Alias** `admin:reset-password`
178178

179179
Reset an admin user's password.
180-
You can pass the email and new password as options or set them interactivly if you call the command without passing the options.
180+
You can pass the email and new password as options or set them interactively if you call the command without passing the options.
181181

182182
**Example**
183183

‎docs/developer-docs/latest/developer-resources/database-apis-reference/entity-service/crud.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Syntax: `findOne(uid: string, id: ID, parameters: Params)` ⇒ `Entry`
2424
### Example
2525

2626
```js
27-
const entry = await strapi.entityService.findOne('api:article.article', 1, {
27+
const entry = await strapi.entityService.findOne('api::article.article', 1, {
2828
fields: ['title', 'description'],
2929
populate: { category: true },
3030
});
@@ -53,7 +53,7 @@ Syntax: `findMany(uid: string, parameters: Params)` ⇒ `Entry[]`
5353
```js
5454
const entries = await strapi.entityService.findMany('api::article.article', {
5555
fields: ['title', 'description'],
56-
filters { title: 'Hello World' },
56+
filters: { title: 'Hello World' },
5757
sort: { createdAt: 'DESC' },
5858
populate: { category: true },
5959
});

‎docs/developer-docs/latest/developer-resources/database-apis-reference/entity-service/populate.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,17 @@ The [Entity Service API](/developer-docs/latest/developer-resources/database-api
1010

1111
## Basic populating
1212

13-
To populate all the root level relations, use `populate: true`:
14-
13+
To populate all the root level relations, use `populate: '*'`:
1514
```js
16-
strapi.entityService('api::article.article').findMany({
17-
populate: true,
15+
const entries = await strapi.entityService.findMany('api::article.article', {
16+
populate: '*',
1817
});
1918
```
2019

21-
Select which data to populate by passing an array of attribute names:
20+
Populate various component or relation fields by passing an array of attribute names:
2221

2322
```js
24-
strapi.entityService('api::article.article').findMany({
23+
const entries = await strapi.entityService.findMany('api::article.article', {
2524
populate: ['componentA', 'relationA'],
2625
});
2726
```
@@ -31,15 +30,16 @@ strapi.entityService('api::article.article').findMany({
3130
An object can be passed for more advanced populating:
3231

3332
```js
34-
strapi.entityService('api::article.article').findMany({
33+
const entries = await strapi.entityService.findMany('api::article.article', {
3534
populate: {
36-
componentB: true,
37-
dynamiczoneA: true,
35+
relationA: true,
3836
repeatableComponent: {
3937
fields: ['fieldA'],
4038
filters: {},
4139
sort: 'fieldA:asc',
42-
populate: false,
40+
populate: {
41+
relationB: true,
42+
},
4343
},
4444
},
4545
});
@@ -48,7 +48,7 @@ strapi.entityService('api::article.article').findMany({
4848
Complex populating can be achieved by using the [`filters` parameter](/developer-docs/latest/developer-resources/database-apis-reference/entity-service/filter.md) and select or populate nested relations or components:
4949

5050
```js
51-
strapi.entityService('api::article.article').findMany({
51+
const entries = await strapi.entityService.findMany('api::article.article', {
5252
populate: {
5353
relationA: {
5454
filters: {

‎docs/developer-docs/latest/developer-resources/database-apis-reference/query-engine/filtering.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ const entries = strapi.db.query('api::article.article').findMany({
169169
});
170170
```
171171

172-
`$in` can be ommited when passing an array of values
172+
`$in` can be omitted when passing an array of values
173173

174174
```js
175175
const entries = strapi.db.query('api::article.article').findMany({

‎docs/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [REST API](/developer-docs/latest/developer-resources/database-apis-referenc
1111

1212
## Sorting
1313

14-
Queries can accept a `sort` parameter that allow sorting on one or multiple fields with the following syntax:
14+
Queries can accept a `sort` parameter that allows sorting on one or multiple fields with the following syntax:
1515

1616
### Sort using 2 fields
1717

‎docs/developer-docs/latest/developer-resources/plugin-api-reference/admin-panel.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ export default {
359359
bootstrap(app) {
360360
// Adding several links at once
361361
app.addSettingsLinks(
362-
'global', // id of the section to addd the link in
362+
'global', // id of the section to add the link in
363363
[{
364364
intLabel: { id: String, defaultMessage: String },
365365
id: String,
@@ -389,7 +389,7 @@ Injection zones are defined in the [register()](#register) lifecycle but compone
389389
390390
Strapi admin panel comes with predefined injection zones so components can be added to the UI of the [Content Manager](/user-docs/latest/content-manager/introduction-to-content-manager.md):
391391
392-
<!-- TODO: maybe add screenshots once design system is ready? -->
392+
<!-- TODO: maybe add screenshots once the design system is ready? -->
393393
394394
| View | Injection zone name & Location |
395395
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

‎docs/developer-docs/latest/developer-resources/plugin-api-reference/server.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/p
99

1010
A Strapi [plugin](/developer-docs/latest/plugins/plugins-intro.md) can interact with the back end or the [front end](/developer-docs/latest/developer-resources/plugin-api-reference/admin-panel.md) of the Strapi application. The Server API is about the back end part.
1111

12-
Creating and using a plugin interacting with the Server API consists in 2 steps:
12+
Creating and using a plugin interacting with the Server API consists of 2 steps:
1313

1414
1. Declare and export the plugin interface within the [`strapi-server.js` entry file](#entry-file)
1515
2. [Use the exported interface](#usage)
@@ -140,10 +140,10 @@ module.exports = () => ({
140140
const contentTypeA = require('./content-type-a');
141141
const contentTypeB = require('./content-type-b');
142142

143-
module.exports = [
143+
module.exports = {
144144
'content-type-a': contentTypeA, // should re-use the singularName of the content-type
145145
'content-type-b': contentTypeB,
146-
];
146+
};
147147
```
148148

149149
```js
@@ -155,7 +155,7 @@ module.exports = {
155155
singularName: 'content-type-a', // kebab-case mandatory
156156
pluralName: 'content-type-as', // kebab-case mandatory
157157
displayName: 'Content Type A',
158-
description: 'A regular content type'
158+
description: 'A regular content type',
159159
kind: 'collectionType'
160160
},
161161
options: {
@@ -386,7 +386,7 @@ module.exports = (options, { strapi }) => {
386386

387387
Once a plugin is exported and loaded into Strapi, its features are accessible in the code through getters. The Strapi instance (`strapi`) exposes top-level getters and global getters.
388388

389-
While top-level getters imply chaining functions, global getters are syntactic sugar that allow direct access using a feature's uid:
389+
While top-level getters imply chaining functions, global getters are syntactic sugar that allows direct access using a feature's uid:
390390

391391
```js
392392
// Access an API or a plugin controller using a top-level getter

‎docs/developer-docs/latest/development/admin-customization.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ The `config` object accepts the following parameters:
9393
| `translations` | Object | [Extends the translations](#extending-translations) |
9494
| `menu` | Object | Accepts the `logo` key to change the [logo](#logos) in the main navigation |
9595
| `theme` | Object | Overrides or [extends the theme](#theme-extension) |
96-
| `tutorial` | Boolean | Toggles [displaying the video tutorials](#tutorial-videos) |
97-
| `notifications` | Object | Accepts the `release` key (Boolean) to toggle [displaying notifications about new releases](#releases-notifications) |
96+
| `tutorials` | Boolean | Toggles [displaying the video tutorials](#tutorial-videos) |
97+
| `notifications` | Object | Accepts the `releases` key (Boolean) to toggle [displaying notifications about new releases](#releases-notifications) |
9898

9999
::: details Example of a custom configuration for the admin panel:
100100

0 commit comments

Comments
 (0)