Release plugin Migration #678

derrickmehaffy · 2022-01-26T15:45:53Z

Add plugin migration
Various syntax fixes around content-type

i found that default authentication route should be `/api/auth/local`

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

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

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>

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

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>

Update default MySQL Port in example to 3306 Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

- bump MyQL/MariaDB Minimum Version for `JSON` datatype support

There should be two enclosing parenthesis at the end. Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

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

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

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

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

Link to correct sendgrid npm

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

* easy syntax correction. should be api:: with double colon * fix typo in entity service example

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

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

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

* Fix locale customisation Signed-off-by: soupette <cyril@strapi.io> * Fix imports paths Signed-off-by: soupette <cyril@strapi.io>

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

* Make sure VuePress is reloaded when updating sidebar files * Shorten script name to load only dev docs

…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 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 * 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 * Update vue-js.md

* 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

Add server-side shared caching example middleware

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

* 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

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

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.

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

* Remove logo used for docs-next * Update logo with a v4-specific one * Revert "Remove logo used for docs-next" This reverts commit a5da57a.

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

vercel · 2022-01-26T15:45:56Z

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

🔍 Inspect: https://vercel.com/strapijs/documentation/GPqoSeqx1BJGwQ8ZcanQKUftcDhk
✅ Preview: https://docs-staging.strapi.io

strapi-cla · 2022-01-26T15:45:58Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
37 out of 39 committers have signed the CLA.

✅ bigpreshy
✅ smoothdvd
✅ sunnysonx
✅ adielbm
✅ sbmvirdi
✅ YegorShtonda
✅ chao-y7
✅ JozefCulen
✅ GauravRajSharma
✅ AmiralBl3ndic
✅ Stun3R
✅ bidoubiwa
✅ FbPalmabit
✅ kasonde
✅ stefanosusini
✅ soupette
✅ pwizla
✅ thezeeshantariq
✅ umair-me
✅ Sharsie
✅ techhtml
✅ azulkipli
✅ YoRolling
✅ alexkainzinger
✅ arielbk
✅ derrickmehaffy
✅ MichalKotowski
✅ GeoFro
✅ Convly
✅ iicdii
✅ armgitaar
✅ rowild
✅ meganelacheny
✅ ronronscelestes
✅ tpimh
✅ stafyniaksacha
✅ jdirand
❌ matthieu-gll
❌ Gonzalo8642
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

azulkipli and others added 30 commits December 3, 2021 18:09

auth route v4 (#553)

878dd7c

i found that default authentication route should be `/api/auth/local`

fix: typo in backend-customization/middlewares.md (#557)

8331eb0

Update i18n.md (#564)

4015bbf

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

Added API suffix (#556)

671e77f

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

fix wrong uid (#558)

26eca70

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

default route user register in v4 (#554)

fe1643f

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)

3af2e51

Fix wrong syntax in GraphQL plugin docs (#537)

e3c97f2

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

Fix broken links in GraphQL & i18n (#583)

245b063

Update default MySQL Port (#575)

cfbdc8a

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)

2ac992f

📖 ⬆️ bump Mysql/MariaDB minimum verison (#593)

2725357

- bump MyQL/MariaDB Minimum Version for `JSON` datatype support

Update controllers.md (#586)

8a40c8b

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)

ce9d14d

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

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

cb078c9

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

Corrected: Database.js Structure and key variable (#603)

ba03adc

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)

3200136

Add information about uid and remove model name for upload ref (#614)

717d9c3

Update server.md (#598)

9cbac74

Update i18n docs, fix locale filter typo + autoformat (#609)

1bf7f3d

Update email.md (#611)

4778be0

Link to correct sendgrid npm

Fix wrong strapi module name for server.js (#615)

2e7f24d

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

easy syntax corrections in entity-service/crud (#620)

529ad33

* easy syntax correction. should be api:: with double colon * fix typo in entity service example

fix some of the broken links (#626)

4688f61

Fix typo in configuration options (#619)

86cf72d

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"

derrickmehaffy and others added 25 commits January 5, 2022 15:37

fix: _locale params renamed to locale (#641)

35f9193

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

3de4f98

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

Fix locale customisation (#645)

9e3cc64

* Fix locale customisation Signed-off-by: soupette <cyril@strapi.io> * Fix imports paths Signed-off-by: soupette <cyril@strapi.io>

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

859b8db

* Make sure VuePress is reloaded when updating sidebar files * Shorten script name to load only dev docs

Fix folder structure for plugin server files

94d4cd2

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

daafff3

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

79fd3ad

* Update vue-js.md * Update vue-js.md

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

599d683

Update graphql.md (#633)

d7b0789

Add server-side shared caching example middleware

Fix typos (#673)

8c4cf83

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

Add admin jwt expire config (#659)

d2e11ee

* 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

Remove not-updated warning (#668)

c79dff2

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

2d09942

Merge branch 'main' of github.com:strapi/documentation

1102ce1

Mention the required use of node prefixes (#669)

fc707a2

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

63bd90f

Update v4 logo (#677)

9ae5447

* Remove logo used for docs-next * Update logo with a v4-specific one * Revert "Remove logo used for docs-next" This reverts commit a5da57a.

Merge branch 'production' into main

c491c6f

vercel bot deployed to Preview January 26, 2022 15:47 View deployment

derrickmehaffy merged commit 195ab50 into production Jan 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Release plugin Migration #678

Release plugin Migration #678

Uh oh!

derrickmehaffy commented Jan 26, 2022

Uh oh!

vercel bot commented Jan 26, 2022 •

edited

Loading

Uh oh!

strapi-cla commented Jan 26, 2022 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

41 participants

Release plugin Migration #678

Release plugin Migration #678

Uh oh!

Conversation

derrickmehaffy commented Jan 26, 2022

Uh oh!

vercel bot commented Jan 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

strapi-cla commented Jan 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

41 participants

vercel bot commented Jan 26, 2022 •

edited

Loading

strapi-cla commented Jan 26, 2022 •

edited

Loading