8000 Corrected: Database.js Structure and key variable by sbmvirdi · Pull Request #603 · strapi/documentation · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Corrected: Database.js Structure and key variable #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 20, 2021

Conversation

sbmvirdi
Copy link
Contributor

The default structure provided in the doc doesn't work on AWS. The provided syntax which has a connection object within the connection object which consists of configurations seems to work.

username key is being replaced with user

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
@strapi-cla
Copy link
strapi-cla commented Dec 17, 2021

CLA assistant check
All committers have signed the CLA.

@vercel
Copy link
vercel bot commented Dec 17, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

documentation – ./docs

🔍 Inspect: https://vercel.com/strapijs/documentation/6UkjukyZHhC2myDVrCerKx5Y2oVn
✅ Preview: https://documentation-git-fork-sbmvirdi-main-strapijs.vercel.app

@vercel
Copy link
vercel bot commented Dec 17, 2021

Deployment failed with the following error:

The most recent charge for your active payment method has failed. Please update it here: https://vercel.com/teams/testeaeaeiueaa/settings/billing.

Copy link
Member
@derrickmehaffy derrickmehaffy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@derrickmehaffy derrickmehaffy merged commit ba03adc into strapi:main Dec 20, 2021
@sbmvirdi
Copy link
Contributor Author

thanks!

derrickmehaffy added a commit that referenced this pull request Dec 20, 2021
* 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 <pwizla@users.noreply.github.com>

* Added API suffix (#556)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* fix wrong uid (#558)

Signed-off-by: harimkims <harimkims@gmail.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Fix remaining localhost links (#568)

* Fix wrong syntax in GraphQL plugin docs (#537)

Signed-off-by: harimkims <harimkims@gmail.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* Fix config example for GraphQL (#591)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* docs: One-to-One should use singular in example (#570)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>
Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* 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 <derrickmehaffy@gmail.com>

* Update docs/developer-docs/latest/development/backend-customization/models.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 missi
8000
ng 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 <pwizla@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* tweak menu + other fixes

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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)

Co-authored-by: azulkipli <8231792+azulkipli@users.noreply.github.com>
Co-authored-by: Alexander Kainzinger <alexander@kainzinger.dev>
Co-authored-by: George F <GeorgeHaroldFrost@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Precious Luke <lukeprecious20@yahoo.com>
Co-authored-by: Kim, Harim <harimkims@gmail.com>
Co-authored-by: Camille Briand <22414709+AmiralBl3ndic@users.noreply.github.com>
Co-authored-by: Adam Miedema <armgitaar@yahoo.com>
Co-authored-by: YoRolling <walldr2161ly@163.com>
Co-authored-by: Zeeshan Tariq <thezeeshantariq@gmail.com>
Co-authored-by: smoothdvd <madfxgao@gmail.com>
Co-authored-by: arielbk <buchwald.kearney@gmail.com>
Co-authored-by: Adiel Ben Moshe <62875424+adielBm@users.noreply.github.com>
Co-authored-by: Shubam Virdi <shubhamvirdic3@gmail.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
derrickmehaffy added a commit that referenced this pull request Dec 28, 2021
* 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 <pwizla@users.noreply.github.com>

* Added API suffix (#556)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* fix wrong uid (#558)

Signed-off-by: harimkims <harimkims@gmail.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Fix remaining localhost links (#568)

* Fix wrong syntax in GraphQL plugin docs (#537)

Signed-off-by: harimkims <harimkims@gmail.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* Fix config example for GraphQL (#591)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* docs: One-to-One should use singular in example (#570)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>
Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* 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 <derrickmehaffy@gmail.com>

* Update docs/developer-docs/latest/development/backend-customization/models.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* tweak menu + other fixes

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <harimkims@gmail.com>

* 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 <derrickmehaffy@gmail.com>

* Update populate.md

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* typos (#628)

* Update upload.md (#616)

Typo in "middleware"

Co-authored-by: azulkipli <8231792+azulkipli@users.noreply.github.com>
Co-authored-by: Alexander Kainzinger <alexander@kainzinger.dev>
Co-authored-by: George F <GeorgeHaroldFrost@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Precious Luke <lukeprecious20@yahoo.com>
Co-authored-by: Kim, Harim <harimkims@gmail.com>
Co-authored-by: Camille Briand <22414709+AmiralBl3ndic@users.noreply.github.com>
Co-authored-by: Adam Miedema <armgitaar@yahoo.com>
Co-authored-by: YoRolling <walldr2161ly@163.com>
Co-authored-by: Zeeshan Tariq <thezeeshantariq@gmail.com>
Co-authored-by: smoothdvd <madfxgao@gmail.com>
Co-authored-by: arielbk <buchwald.kearney@gmail.com>
Co-authored-by: Adiel Ben Moshe <62875424+adielBm@users.noreply.github.com>
Co-authored-by: Shubam Virdi <shubhamvirdic3@gmail.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Richard Nsama <kasonde.nsama@gmail.com>
Co-authored-by: Stefano <1021479+stefanosusini@users.noreply.github.com>
Co-authored-by: Jean-Sébastien Herbaux <jean-sebastien.herbaux@epitech.eu>
Co-authored-by: Francesco Bianchi <f.bianchi@palmabit.com>
Co-authored-by: Sharsie <Sharsie@users.noreply.github.com>
Co-authored-by: sunnyson <catan.marin@gmail.com>
Co-authored-by: Jozef Culen <jozcul@gmail.com>
derrickmehaffy added a commit that referenced this pull request Jan 5, 2022
* 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 <pwizla@users.noreply.github.com>

* Added API suffix (#556)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* fix wrong uid (#558)

Signed-off-by: harimkims <harimkims@gmail.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Fix remaining localhost links (#568)

* Fix wrong syntax in GraphQL plugin docs (#537)

Signed-off-by: harimkims <harimkims@gmail.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* Fix config example for GraphQL (#591)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* docs: One-to-One should use singular in example (#570)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>
Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* 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 <derrickmehaffy@gmail.com>

* Update docs/developer-docs/latest/development/backend-customization/models.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* tweak menu + other fixes

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <harimkims@gmail.com>

* 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 <derrickmehaffy@gmail.com>

* Update populate.md

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* typos (#628)

* Update upload.md (#616)

Typo in "middleware"

* Fixed content type export object & missing commas (#627)

Without { schema } don`t work( I use v4.0.2
In another plugin:
https://github.com/strapi/strapi/blob/master/packages/plugins/users-permissions/server/content-types/index.js

* fix(dev/docs): typo `intLabel` to `intlLabel` (#625)

* Update services.md (#632)

* Update services.md

* Update services.md

* Fix link formatting in v4 REST API

* remove clean flag from build commands (#623)

* Update docs/developer-docs/latest/concepts/draft-and-publish.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

Co-authored-by: azulkipli <8231792+azulkipli@users.noreply.github.com>
Co-authored-by: Alexander Kainzinger <alexander@kainzinger.dev>
Co-authored-by: George F <GeorgeHaroldFrost@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Precious Luke <lukeprecious20@yahoo.com>
Co-authored-by: Kim, Harim <harimkims@gmail.com>
Co-authored-by: Camille Briand <22414709+AmiralBl3ndic@users.noreply.github.com>
Co-authored-by: Adam Miedema <armgitaar@yahoo.com>
Co-authored-by: YoRolling <walldr2161ly@163.com>
Co-authored-by: Zeeshan Tariq <thezeeshantariq@gmail.com>
Co-authored-by: smoothdvd <madfxgao@gmail.com>
Co-authored-by: arielbk <buchwald.kearney@gmail.com>
Co-authored-by: Adiel Ben Moshe <62875424+adielBm@users.noreply.github.com>
Co-authored-by: Shubam Virdi <shubhamvirdic3@gmail.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Richard Nsama <kasonde.nsama@gmail.com>
Co-authored-by: Stefano <1021479+stefanosusini@users.noreply.github.com>
Co-authored-by: Jean-Sébastien Herbaux <jean-sebastien.herbaux@epitech.eu>
Co-authored-by: Francesco Bianchi <f.bianchi@palmabit.com>
Co-authored-by: Sharsie <Sharsie@users.noreply.github.com>
Co-authored-by: sunnyson <catan.marin@gmail.com>
Co-authored-by: Jozef Culen <jozcul@gmail.com>
Co-authored-by: Yagor Shtonda <shtyegor@gmail.com>
Co-authored-by: Gaurav Sharma <blazegaurav123@gmail.com>
Co-authored-by: Muhammad Umair Irshad <m_umair_85@hotmail.com>
derrickmehaffy added a commit that referenced this pull request Jan 26, 2022
* 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 <pwizla@users.noreply.github.com>

* Added API suffix (#556)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* fix wrong uid (#558)

Signed-off-by: harimkims <harimkims@gmail.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Fix remaining localhost links (#568)

* Fix wrong syntax in GraphQL plugin docs (#537)

Signed-off-by: harimkims <harimkims@gmail.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* Fix config example for GraphQL (#591)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* docs: One-to-One should use singular in example (#570)

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>
Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* 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 <derrickmehaffy@gmail.com>

* Update docs/developer-docs/latest/development/backend-customization/models.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <pwizla@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* tweak menu + other fixes

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* 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 <harimkims@gmail.com>

* 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 <derrickmehaffy@gmail.com>

* Update populate.md

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* typos (#628)

* Update upload.md (#616)

Typo in "middleware"

* Fixed content type export object & missing commas (#627)

Without { schema } don`t work( I use v4.0.2
In another plugin:
https://github.com/strapi/strapi/blob/master/packages/plugins/users-permissions/server/content-types/index.js

* fix(dev/docs): typo `intLabel` to `intlLabel` (#625)

* Update services.md (#632)

* Update services.md

* Update services.md

* Fix link formatting in v4 REST API

* remove clean flag from build commands (#623)

* Update docs/developer-docs/latest/concepts/draft-and-publish.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Small typo in Quick Start Guide, word "Next" occurs twice unnecessarily (#638)

Removed one of the occurrences.

* Add warning to email doc to use full provider name (#636)

* Add warning to email doc to use full provider name

* lets use an email provider not upload

* Update docs/developer-docs/latest/plugins/email.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/plugins/email.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* fix upload providers too

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* fix: _locale params renamed to locale (#641)

* fix(docs): Change wording error in tab Twitch (#604)

Change "Discord accepts [...]" to "Twitch accepts [...]"

* Fix locale customisation (#645)

* Fix locale customisation

Signed-off-by: soupette <cyril@strapi.io>

* Fix imports paths

Signed-off-by: soupette <cyril@strapi.io>

* Improve dev experience (#577)

* Init create config file

Signed-off-by: soupette <cyril@strapi.io>

* Split sidebar

Signed-off-by: soupette <cyril@strapi.io>

* Split sidebar

Signed-off-by: soupette <cyril@strapi.io>

* Split config and write config file before launching the dev server

Signed-off-by: soupette <cyril@strapi.io>

* Add config.js to gitignore and move all config files into the config folder

Signed-off-by: soupette <cyril@strapi.io>

* Init patterns to split user et dev docs

Signed-off-by: soupette <cyril@strapi.io>

* Split dev config

Signed-off-by: soupette <cyril@strapi.io>

* Split sidebar between use case

Signed-off-by: soupette <cyril@strapi.io>

* cleanup extra space

Co-authored-by: derrickmehaffy <derrickmehaffy@gmail.com>
Co-authored-by: Pierre Wizla <pwizla+github@gmail.com>

* Quality-of-life improvements for new build scripts (#651)

* Make sure VuePress is reloaded when updating sidebar files

* Shorten script name to load only dev docs

* Fix folder structure for plugin server files

* [unrelated to migration] Restore missing REST API items in sidebar

* Update Google Cloud Platform deployment documentation for strapi v4 (#647)

* Update Google Cloud Platform deployment documentation for strapi v4

* Update database configurations without socketPath

* Applying docs reviews

* Update docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/google-app-engine.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update AWS deployment documentation (#653)

* Update AWS deployment documentation

The added lines here are to make sure Webhooks work fine when `ufw` has enabled which is in the step below of installing Nginx, in other words, without this command Webhooks cannot connect to the host server due to firewall. 
Thanks!

* Update docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/amazon-aws.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Fix JWT using wrong file and structure (#649)

* Fix JWT using wrong file and structure

* Update docs/developer-docs/latest/plugins/users-permissions.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/plugins/users-permissions.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update docs/developer-docs/latest/plugins/users-permissions.md

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* add link to env

Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

* Update vue-js.md code example to list the restaurants (#654)

* Update vue-js.md

* Update vue-js.md

* Fix broken links to iso-locales.json (#670)

* Product Copy - Wording updates in User Guide + Dev Docs (#658)

* Apply right wording everywhere for collection type, single type and content-type

* Apply right wording everywhere for Content-type Builder

* Apply right wording everywhere for end user

* Apply right wording everywhere for sub navigation

* Apply right wording everywhere for Content Manager

* Update graphql.md (#633)

Add server-side shared caching example middleware

* Fix typos (#673)

Co-authored-by: Gonzalo <gnpantoja@outlook.com>

* Add admin jwt expire config (#659)

* Add auth.options and auth.options.expiresIn

* Revert "Add auth.options and auth.options.expiresIn"

This reverts commit 41d7176.

* Redo commit to exclude the yarn.lock

* Guide Register field in admin panel (#610)

* init config

* wip

* improved layout and added components examples

* last quick fixes + flow tests

* added tip with reference to the guide in admin panel API doc

* feedback fixes

* fixed wording for the 5th step in plugin setup

* fixed formatMessage description + wysiwyg example label

* feedback fixes

Co-authored-by: Vincent <vincentbpro@users.noreply.github.com>

* Capitalize code-block titles (consistency with other documentation)

* Fix some paths in code examples

* Explicitly describe what we'll do

`::details` blocks in VuePress should be used for content that is
optional to read and can be skipped. If we skip them, we at least need
to understand what the "Creating the WYSIWYG" section is about.

* Add result screenshot

* Add links to user guide

* Enhance formatting + be more explicit about replacing index.js content

* note to explain 1337 error in watch admin added

* Reword the last note a bit

Co-authored-by: Vincent <vincentbpro@users.noreply.github.com>
Co-authored-by: Pierre Wizla <pwizla+github@gmail.com>

* Remove not-updated warning (#668)

This guide also works well with Strapi v4, therefore the warning can be removed as discussed in #666 (what a number!)
Additionally, some small grammar errors were fixed.

* Fix headings in Heroku guide

* Mention the required use of node prefixes (#669)

Adds a note mentioning the recommended way of installation and the use of node-typical prefixes.

* Reword CLI note to be a bit more neutral

* Update v4 logo (#677)

* Remove logo used for docs-next

* Update logo with a v4-specific one

* Revert "Remove logo used for docs-next"

This reverts commit a5da57a.

* Plugin migration guide (#663)

* Initial commit of plugin MG (rough draft + a few enhancements)

* Update introduction

* Add `canonicalUrl` SEO parameter (TODO: add actual URL)

* Fix path in optional plugins config. file.

* Update headings

* Turn conclusion into a :::strapi callout

* Rewrite the "Enable the plugin" section

* [unrelated to migration] Restore missing REST API items in sidebar

* Make h1 singular

* Fix folder structure for plugin server files

* Update folder structure

* Improve intro

* Improve "Enable the plugin"

* Improve "Update folder structure" intro

* Improve the "update the folder structure"

* Edit TOC entry

* Test deeper TOC look

* Improve again the "update the folder structure"

* Be more explicit with paths in Server API docs

* Fix project structure

* Finish improving the "update the folder structure" subsections 🥳

* Break down the guide into different files

* Add cross-link note (update folder <> back end) for content-types

* Fix title-case in "update folder structure" file's h1

* Add reworked "migrate the back end" section

* Add reworked "migrate the front end" section

* Add various improvements to back-end, front-end and folder structure sections

* Add more subtle improvements to "update folder structure" section

* Explicitly state that front end migration is manual-only

* Add further readability and structure improvements

… and get rid of the cd-codemod-folder.md as it causes issues.
(Looks like, because we're using `<` and `>` for text should be replaced
VuePress thinks this is an HTML tag 🤷. It works when used in a code
block, but not if trying to insert a line from a snippet into an
already existing code block…

* Update v4 migration guides introduction in general migration guides doc

* Update links navigation between plugin migration guide topics

* Update WIP callout for consistency with user docs

* Improve v3/v4 comparisons: add callout + fix wording "Strapi v3/v4"

* Fix in Server API docs based on Mark's feedback

* Update folder structure requirements (re. entry files)

* Fix life cycle → lifecycle in the whole documentation

* Add more improvements based on devs feedback

* Make `validator` optional

* 💄 Format table

* Update codemods to the latest ones and remove repo cloning prereq.

* Update 3.6.9 → 3.6.8 as 3.6.9 is not out yet

* Add missing Oxford comma

* Fix casing and dash on v3 heading

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* Fix package name declaration code

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* Fix package name declaration code (here as well :D)

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

* Remove trailing slash in controller path to prevent koa errors

* Update WIP callout

* Improve with Mégane's feedback

* Be more explicit about server/index.js

* fix: Minor cleanup and rewrites to match CLI generated plugins

* ops, don't change version

* Update paths for plugin server files for consistency w/ plugin migration

* Add one more missing strapi-server vs. server/index occurence

* Clean up & fix broken links

* Update SEO meta tags

Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

Co-authored-by: azulkipli <8231792+azulkipli@users.noreply.github.com>
Co-authored-by: Alexander Kainzinger <alexander@kainzinger.dev>
Co-authored-by: George F <GeorgeHaroldFrost@gmail.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Precious Luke <lukeprecious20@yahoo.com>
Co-authored-by: Kim, Harim <harimkims@gmail.com>
Co-authored-by: Camille Briand <22414709+AmiralBl3ndic@users.noreply.github.com>
Co-authored-by: Adam Miedema <armgitaar@yahoo.com>
Co-authored-by: YoRolling <walldr2161ly@163.com>
Co-authored-by: Zeeshan Tariq <thezeeshantariq@gmail.com>
Co-authored-by: smoothdvd <madfxgao@gmail.com>
Co-authored-by: arielbk <buchwald.kearney@gmail.com>
Co-authored-by: Adiel Ben Moshe <62875424+adielBm@users.noreply.github.com>
Co-authored-by: Shubam Virdi <shubhamvirdic3@gmail.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Richard Nsama <kasonde.nsama@gmail.com>
Co-authored-by: Stefano <1021479+stefanosusini@users.noreply.github.com>
Co-authored-by: Jean-Sébastien Herbaux <jean-sebastien.herbaux@epitech.eu>
Co-authored-by: Francesco Bianchi <f.bianchi@palmabit.com>
Co-authored-by: Sharsie <Sharsie@users.noreply.github.com>
Co-authored-by: sunnyson <catan.marin@gmail.com>
Co-authored-by: Jozef Culen <jozcul@gmail.com>
Co-authored-by: Yagor Shtonda <shtyegor@gmail.com>
Co-authored-by: Gaurav Sharma <blazegaurav123@gmail.com>
Co-authored-by: Muhammad Umair Irshad <m_umair_85@hotmail.com>
Co-authored-by: Michał Kotowski <45261767+MichalKotowski@users.noreply.github.com>
Co-authored-by: Thibaut DAVID <34125897+Stun3R@users.noreply.github.com>
Co-authored-by: mgelle-labs <matthieu.gelle@gmail.com>
Co-authored-by: cyril lopez <cyril@strapi.io>
Co-authored-by: Pierre Wizla <pwizla+github@gmail.com>
Co-authored-by: John Cho (조은) <apes0123@gmail.com>
Co-authored-by: Chao <hi@cyin.live>
Co-authored-by: Julia Dirand <julia.dirand@gmail.com>
Co-authored-by: Dima Golovin <dima@golovin.in>
Co-authored-by: meganelacheny <megane.lacheny@strapi.io>
Co-authored-by: Sacha STAFYNIAK <sacha.stafyniak@gmail.com>
Co-authored-by: Gonzalo Pantoja <16733681+Gonzalo8642@users.noreply.github.com>
Co-authored-by: Gonzalo <gnpantoja@outlook.com>
Co-authored-by: ronronscelestes <71838159+ronronscelestes@users.noreply.github.com>
Co-authored-by: Vincent <vincentbpro@users.noreply.github.com>
Co-authored-by: Robert Wildling <rowild@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0