Skip to content

Commit bb9a686

Browse files
derrickmehaffykasondemikeboltCollisio Technologiespwizla
authored
Deploy day one fixes (#530)
* Removed Slack from the Navbar Community dropdown (#384) * Edit the "Create a Go File" section (#388) The word "built-in" is much more common than "inbuilt". Go has packages, and we don't need to refer to them as "packages/modules". Also, add a missing comma. * remove DO managed db warning (#390) Co-authored-by: Pierre Wizla <[email protected]> * Add hiring link (#387) Co-authored-by: Pierre Wizla <[email protected]> * Case for 1 can be handled in loop (#370) Co-authored-by: Pierre Wizla <[email protected]> * Change code snippet for service create customisation (#372) * Change code snippet for service create customisation * Review changes * VuePress enhancements (#368) * Add consistency * Add strapi & prerequisites Markdown containers Note: Using babel-style for plugins declarations as it seems to work better with multiple declarations for vuepress-plugin-container * Use :::strapi and :::prerequisites in existing docs * Add generic callout, tweak strapi & tip callouts, and clean config file * Clean up unused inline styles from Markdown files * Remove 🤓 from Markdown files in strapi callouts as it's now included * Use generic callout for congratulations in QSG * Add api-call, request and response custom containers * Fully redesign style for request & response containers * Use api-callout container on existing documentation * Remove emoji from :::strapi as it's included * Add 'note' custom callout * Add 'important', 'caution' and 'warning' custom callouts In our mind, they are 3 different levels: - important, the less strong - caution, medium importance ( = VuePress's default 'warning') - warning, the strongest ( = VuePress's default 'danger') * Remove important callout & cleanup CSS We decided that we'll go with a unique callout, "caution". The title can still be adjusted when necessary. * Merge branch 'repo/snippets' into repo/vuepress-enhanced * Apply new callouts and minimal tab styles everywhere * Apply minimal tabs to integration guides * Update VuePress to 1.8.2 * Temporarily setting root url (testing Vercel deploy) * Revert "Temporarily setting root url (testing Vercel deploy)" This reverts commit ba7b7d264b38c844ae6f5131f851f715560c8ec4. * Use code-blocks and code-groups everywhere appropriate * Tweak request/response CSS based on designers feedback * Simplify some wordings in i18n doc * Apply api-call/request/response containers throughout the docs * Tweak request/response CSS for use outside of :::api-call * Update callouts in the user guide * Remove Google Analytics Vuepress plugin and add GTM See [this PR](https://github.com/strapi/documentation/pull/380) * Temp remove yarn.lock to fix conflicts * Fix emoji for warning callout * Converting warning to note callout in Templates file * Fix QSG callouts * Add yarn.lock * Remove marketing note at end of 21yunbox hosting guide * Removing GTM script from plugins (it's already in head) * Don't make text prop required in badges as a default is already provided Co-authored-by: Mégane Lacheny <[email protected]> * Highlight active tab in blue instead of default VuePress green (#393) * Fix CLI commands for Hand-on path in QSG (#395) * Launch the server: added steps to execute build & start on windows (#394) Co-authored-by: Pierre Wizla <[email protected]> * Remove breaking markdown on laravel page (#398) * Remove breaking markdown on laravel page There was a line that broke the layout of the entire page, making everything after the tag be placed inline. By removing this it will all be normal and readable again. * Close a block in the angular documentation * Close a block in the gridsome documentation * Close a block in the 11ty documentation * Update python.md (#400) Fixed the syntax error in line 125. * Update laravel.md (#402) Fixed a wrong word * small grammar fix (#405) from "is uses" to "uses" * Update is/are conjugation mistake in FAQ (#406) * Add Okta example to SSO (#396) Co-authored-by: Pierre Wizla <[email protected]> * Grammar correction (#414) * Use a nodejs version supported by Strapi (#411) Node v10 is not supported anymore. See https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/deployment.html Use Node v14 in Standard Environment. See https://cloud.google.com/appengine/docs/standard/nodejs/runtime#node.js-14 Note about Flexible Environment: It will derive the right Node version from package.json. See https://cloud.google.com/appengine/docs/flexible/nodejs/runtime Co-authored-by: Pierre Wizla <[email protected]> * Fix socketPath usage on google app engine (#392) See https://stackoverflow.com/a/67395883/856702 Co-authored-by: Pierre Wizla <[email protected]> * Update laravel.md (#410) A config file is needed Co-authored-by: Pierre Wizla <[email protected]> * Fix for the Okta sample config (#419) * Fix grammar (#421) * Update migration-guide-3.4.x-to-3.4.4.md * Update migration-guide-3.4.x-to-3.4.4.md * Update sentence for initializer in folder structure (#426) * Update README.md (#427) Update Node version: https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/installation/cli.html#preparing-the-installation `Node.js (opens new window): only LTS versions are supported (version 12.x minimum). Other versions of Node.js may not be compatible with the latest release of Strapi. The 14.x version is most recommended by Strapi.` * [dev/latest-guides-auth-request] Fixed grammatical error (#431) * Fixed grammatical error * Fixed to better match style guide Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * npm build command doesn't work. Use npm run build (#440) See: https://stackoverflow.com/questions/29939697/npm-build-doesnt-run-the-script-named-build-in-package-json This should also be updated across the docs wherever its found. Maybe I'll go hunting soon if this one gets merged (first time contributor here 😊) * Update note in v3 migration guides (#449) * fix publicationState filter docs (#425) Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Believe there is a typo in the file name (#471) servers.js should be server.js * [v3] CLI Node version reference (#470) * [v3] CLI Node version reference * make it clear we won't backport node 16 support Co-authored-by: Pierre Wizla <[email protected]> * Add Strapi handbook links (#492) * Update 'Database Access' location (#487) The mongodb dashboard does not have an 'Overview' section anymore as implied in the strapi mongodb docs. They now have a 'Deployment' section and 'Database Access' has been moved to the 'Security' section. Co-authored-by: Pierre Wizla <[email protected]> * Update amazon-aws.md (#484) Co-authored-by: Pierre Wizla <[email protected]> * v4 Documentation to Staging (#507) * Enhance Models section * Enhance Models section * Move Database API Reference before Plugin API Reference in sidebar * Enhance GraphQL API * Enhance Query Engine API * Enhance REST API * Enhance plugin-related parts * Enhance REST API * Enhance Query Engine API * Enhance GraphQL API * Enhance plugin-related parts * Edit a path for an Admin Customization code example * Add the `useCMEditViewDataManeger` hook to Injection Zones section * Revert "Add second Content Manager-related hook to Hooks API section" This reverts commit aafbfb102ab771e64821a38a2f022a91b40276fc. * Remove superfluous example of component injection Seems like a duplicate usage of the bigger example that can be found below. * Enhance injection zones usage description * Edit a path for an Admin Customization code example * Revert "Add second Content Manager-related hook to Hooks API section" This reverts commit aafbfb102ab771e64821a38a2f022a91b40276fc. * Add the `useCMEditViewDataManeger` hook to Injection Zones section * Remove superfluous example of component injection Seems like a duplicate usage of the bigger example that can be found below. * Enhance injection zones usage description * Improve some tables in Admin Panel API * Enhance again injection zones 😅 * Improve some tables in Admin Panel API * Enhance again injection zones 😅 * Update heading for using useCMEditViewDataManager * Update heading for using useCMEditViewDataManager * Fix broken link to predefined injection zones * Fix broken link to predefined injection zones * Remove some TODOs * Remove some TODOs * Drop mongo from README * Drop mongo from DatabaseLinks component * Drop mongo from CLI and global API references * Drop Mongo from configurations for deployment * Drop Mongo from FAQ * Drop Mongo from slug guide * Drop Mongo from Configurations * Drop Mongo from deployment guides * Drop Mongo from installation guides * Remove unused warning snippet for MongoDB drop * Fix typos in FAQ * Remove environment variables that aren't used anymore * Remove unaccessible config keys from `logger` middleware * Add custom config for `logger` middleware * Split Configurations section into files * Move database & server config docs to their own files * Update environment config docs headings * Update path to admin/app.js * Remove MongoDB references that might conflict with dev/v4-dropping-mongo * Improve configurations intro * Use "strapi" callouts where appropriate * Reformat core middlewares configurations as tables * Improve the middlewares section further * Enhance Optional Configurations > Environment section * Enhance Optional Configurations > API section * Add link to Optional Config > API for default and max pagination limits * Add further minor improvements to optional config intro and environment * Slightly enhance the Optional Config > Functions section * Slightly enhance the Optional Config > Public assets section * Enhance Optional config > SSO section This includes getting rid of tabs for configuration providers examples as clients often ask for direct links to the provider they want to use. cc @dmehaffy :-) * Make "Single Sign-On" spelling consistent * Add interactive project structure map * Move Strapi Plugins section below Development in sidebar * Fix broken links * Remove unused local plugins customization file * Collapse backend customization by default * Collapse backend customization by default * Collapse backend customization by default * Don't have sections without a proper `path` greyed out * Add quick wins to Admin Panel Customization based on Mégane's feedback * Update docs/developer-docs/latest/developer-resources/database-apis-reference/query-engine/bulk-operations.md * Add a few tiny enhancements to REST API * Create a Content API section * Improve Models section * Update 'key' vs 'parameter' wording to make its usage consistent * Update GraphQL with JS feedback * Update Plugins (intro, development, extension) with Pierre N's feedback * Update GraphQL with JS feedback * Update Plugins (intro, development, extension) with Pierre N's feedback * Update docs/developer-docs/latest/setup-deployment-guides/configurations.md Co-authored-by: meganelacheny <[email protected]> * Fix Winston vs. Pino Co-authored-by: DMehaffy <[email protected]> * [v4] Dev Docs - Dropping MongoDB (#424) * Fix for the Okta sample config (#419) * Drop mongo from README * Drop mongo from DatabaseLinks component * Drop mongo from CLI and global API references * Drop Mongo from configurations for deployment * Drop Mongo from FAQ * Drop Mongo from slug guide * Drop Mongo from Configurations * Drop Mongo from deployment guides * Drop Mongo from installation guides * Remove unused warning snippet for MongoDB drop Co-authored-by: DMehaffy <[email protected]> * Add TODO about "add admin jwt config option" * Update TODO (field-related actions in GraphQL custom) + path * Add yaml for plugins extension * Add TODOs and fix stuff with soupette's feedback * Convert strapi to prerequisites callout * Add queries & mutations explanation * Update Admin Panel files based on soup's & Mégane's feedback * Update Admin Panel files based on soup's & Mégane's feedback * Add code example to extend translations (admin panel customization) * Fix path to server config docs * Don't have sections without a proper `path` greyed out * Move `title` before `collapsable` in dev sidebar config * Move Development before Strapi plugins in sidebar * Enhance Plugins development & intro + create plugins configuration docs * Update plugins extension section with Mégane's & Pierre N.'s feedbacks * Add documentation for register() function found in src/index.js * Simplify plugins auto-discovery wording * Fix code syntaxes in Server API for Plugins * Refine plugins extensions within src/index.js * Add TODO about upcoming destroy() function in src/index.js * Refine Server API with Mégane's feedback * Update Plugins extension based on Mégane's feedback * [v4] Dev Docs - "Lighter" updates (#430) * Fix typos in FAQ * Remove environment variables that aren't used anymore * Remove unaccessible config keys from `logger` middleware * Add custom config for `logger` middleware * Add interactive project structure map * Replace app with application Co-authored-by: meganelacheny <[email protected]> * Refine FAQ entry for deep filter (1 on 2) Co-authored-by: meganelacheny <[email protected]> * Update FAQ * Update project structure * Update FAQ entry for (deep) filter * Update project structure to include src/index.js Co-authored-by: meganelacheny <[email protected]> * Update project structure * Add comment to src/index.js in project structure * Add more tweaks to project structure * Rename Database APIs reference and include them in a simple "APIs reference" * Improve Query Engine API and REST API docs * Fix syntaxes in controllers documentation * Enhance GraphQL docs based on JS's feedback * Rename global strapi API reference's h1 * Move Plugin API reference to APIs reference section in sidebar * Remove old, empty content-api file * Remove old, empty backend-customization file * Remove old, empty mondodb database guide * Fix broken links in admin-customization and plugins-extension * [v4] Dev Docs - Reworked "Configurations" section (#429) * Unify order of optional configurations in text and sidebar * Remove database ORM customization from config > optional > functions * Rename Bookshelf tab to SQL in config > required > databases * Fix more broken links * Add mini-intro for GraphQL API * Add mini-intro for GraphQL API * Add mini-intro for REST API + fix related items * Add mini-intro for REST API + fix related items * Remove unused heading in plugins extension * Wording: Content API → REST & GraphQL * Fix links in project structure file * Wording: Content API → REST & GraphQL * Remove unused heading in plugins extension * Delete unused content-api.md * Remove unused comment after file splitting * Remove comments * Delete hooks * Fix plugins-extension (paths, code example code, heading) * Add code example for field actions in GraphQL custom * Fix broken links * Update configuration > optional > functions with bootstrap and register * Add temporary beta badge in nav bar * [v4] Dev Docs updates to Plugins (Development, Extension, APIs) + Admin Panel customization (#418) * Add Plugin API * Delete unused plugin-api-reference/extension.md file The content is documented in development/plugin-extensions.md * Delete old local-plugins-customization file * Fix root metaredirection in readme * Improve description of createSettingSection() * Add live updates of Admin Panel stuff based on Cyril's first feedback * 💄 "Example" → "Example:" * Improve Server API docs * Rename "Local plugins customization" to "Plugins development" * Improve Plugins extension section * Improve Admin Panel API and Customization sections * Fix broken links * Add second Content Manager-related hook to Hooks API section * Improve Admin Panel API * Update the example `config` in Admin Panel customization * Further enhance the previous `config` example in Admin Panel custom. * 💄 Enhance even more the `config` section * Add list of locales to Admin Customization * Enhance plugin-related parts * Edit a path for an Admin Customization code example * Revert "Add second Content Manager-related hook to Hooks API section" This reverts commit aafbfb102ab771e64821a38a2f022a91b40276fc. * Add the `useCMEditViewDataManeger` hook to Injection Zones section * Remove superfluous example of component injection Seems like a duplicate usage of the bigger example that can be found below. * Enhance injection zones usage description * Improve some tables in Admin Panel API * Enhance again injection zones 😅 * Update heading for using useCMEditViewDataManager * Fix broken link to predefined injection zones * Remove some TODOs * Update path to admin/app.js * Add quick wins to Admin Panel Customization based on Mégane's feedback * Update Plugins (intro, development, extension) with Pierre N's feedback * Fix Winston vs. Pino Co-authored-by: DMehaffy <[email protected]> * Add yaml for plugins extension * Add TODOs and fix stuff with soupette's feedback * Update Admin Panel files based on soup's & Mégane's feedback * Add code example to extend translations (admin panel customization) * Fix path to server config docs * Don't have sections without a proper `path` greyed out * Move `title` before `collapsable` in dev sidebar config * Move Development before Strapi plugins in sidebar * Enhance Plugins development & intro + create plugins configuration docs * Update plugins extension section with Mégane's & Pierre N.'s feedbacks * Add documentation for register() function found in src/index.js * Simplify plugins auto-discovery wording * Fix code syntaxes in Server API for Plugins * Refine plugins extensions within src/index.js * Add TODO about upcoming destroy() function in src/index.js * Refine Server API with Mégane's feedback * Update Plugins extension based on Mégane's feedback * Remove unused heading in plugins extension * Fix plugins-extension (paths, code example code, heading) Co-authored-by: DMehaffy <[email protected]> * Update beta badge color * Fix more broken links after merge * [v4 - dev docs] "Next-2" release (#437) * Comment out customization in GraphQL plugin as it's not ready yet * Improve GraphQL API section * Rollback to warning instead of caution for deep filtering performances * Rollback to using "entry" instead of "entity" everywhere * Make tiny enhancements to GraphQL API doc * Enhance REST API doc * Make slight enhancements to Models section * Delete unused "Advanced Database Guides" * Remove Queries section from backend custom and use content for Query Engine API intro * Split 'plugins' and 'sidebar' keys out of `config.js` for easier handling * Fully rework the models section * Revert "Split 'plugins' and 'sidebar' keys out of `config.js` for easier handling" This reverts commit b5bbfa1b4a4a77259906eb9f53e4c9bd2c3419c8. * Split backend customization into one file per section * Include 'Path: ' information as comments in code examples * Remove "Example(s)" headers * Add FontAwesome icon to link relation/component/DZ types sections * Lint GraphQL API * Add a few questions for devs to GraphQL API * Cleanup REST API doc * Add missing path to programmatic usage example of lifecycle hooks * Finish fully reworking the models section * Add :::strapi callout at top of GraphQL page * Add small introduction to Query Engine API * Delete sidebar.js I decided to revert changes about sidebar and move it back to config.js since moving it out of config.js breaks auto-refresh. I forgot to delete the file in the previous revert commit. * Remove completed TODOs * Rollback "entities" → "entries" in i18n.md * Make Database APIs Reference collapsable in sidebar * ⛓ Fix broken links * Fix all remaining broken links and update ignored files in config.js * Reformat parameter tables in single/bulk operations Query Engine API Plus add link icons for more explicit linking * Add `encodeValuesOnly` to qs example for a prettier url in REST API * Also add `require` in qs filter example * Add Plugin API * Delete unused plugin-api-reference/extension.md file The content is documented in development/plugin-extensions.md * Delete old local-plugins-customization file * Fix root metaredirection in readme * Improve description of createSettingSection() * Fix config * Enhance based on Pierre Noel's feedback * Add live updates of Admin Panel stuff based on Cyril's first feedback * 💄 "Example" → "Example:" * Improve Server API docs * Rename "Local plugins customization" to "Plugins development" * Improve Plugins extension section * Improve Admin Panel API and Customization sections * Fix broken links * Add second Content Manager-related hook to Hooks API section * Improve Admin Panel API * Update the example `config` in Admin Panel customization * Further enhance the previous `config` example in Admin Panel custom. * 💄 Enhance even more the `config` section * Add list of locales to Admin Customization * Add GraphQL customization * Add types to `extension` object parameters in GraphQL customization * Mention LHS bracket syntax * Simplify table for pagination by offset * Document the use of wildcards in REST API * Restore the proper "Plugins development" section * Fix broken links * Enhance Models section * Enhance Models section * Move Database API Reference before Plugin API Reference in sidebar * Enhance GraphQL API * Enhance Query Engine API * Enhance REST API * Enhance plugin-related parts * Enhance REST API * Enhance Query Engine API * Enhance GraphQL API * Enhance plugin-related parts * Edit a path for an Admin Customization code example * Add the `useCMEditViewDataManeger` hook to Injection Zones section * Revert "Add second Content Manager-related hook to Hooks API section" This reverts commit aafbfb102ab771e64821a38a2f022a91b40276fc. * Remove superfluous example of component injection Seems like a duplicate usage of the bigger example that can be found below. * Enhance injection zones usage description * Edit a path for an Admin Customization code example * Revert "Add second Content Manager-related hook to Hooks API section" This reverts commit aafbfb102ab771e64821a38a2f022a91b40276fc. * Add the `useCMEditViewDataManeger` hook to Injection Zones section * Remove superfluous example of component injection Seems like a duplicate usage of the bigger example that can be found below. * Enhance injection zones usage description * Improve some tables in Admin Panel API * Enhance again injection zones 😅 * Improve some tables in Admin Panel API * Enhance again injection zones 😅 * Update heading for using useCMEditViewDataManager * Update heading for using useCMEditViewDataManager * Fix broken link to predefined injection zones * Fix broken link to predefined injection zones * Remove some TODOs * Remove some TODOs * Drop mongo from README * Drop mongo from DatabaseLinks component * Drop mongo from CLI and global API references * Drop Mongo from configurations for deployment * Drop Mongo from FAQ * Drop Mongo from slug guide * Drop Mongo from Configurations * Drop Mongo from deployment guides * Drop Mongo from installation guides * Remove unused warning snippet for MongoDB drop * Fix typos in FAQ * Remove environment variables that aren't used anymore * Remove unaccessible config keys from `logger` middleware * Add custom config for `logger` middleware * Split Configurations section into files * Move database & server config docs to their own files * Update environment config docs headings * Update path to admin/app.js * Remove MongoDB references that might conflict with dev/v4-dropping-mongo * Improve configurations intro * Use "strapi" callouts where appropriate * Reformat core middlewares configurations as tables * Improve the middlewares section further * Enhance Optional Configurations > Environment section * Enhance Optional Configurations > API section * Add link to Optional Config > API for default and max pagination limits * Add further minor improvements to optional config intro and environment * Slightly enhance the Optional Config > Functions section * Slightly enhance the Optional Config > Public assets section * Enhance Optional config > SSO section This includes getting rid of tabs for configuration providers examples as clients often ask for direct links to the provider they want to use. cc @dmehaffy :-) * Make "Single Sign-On" spelling consistent * Add interactive project structure map * Move Strapi Plugins section below Development in sidebar * Fix broken links * Remove unused local plugins customization file * Collapse backend customization by default * Collapse backend customization by default * Collapse backend customization by default * Don't have sections without a proper `path` greyed out * Add quick wins to Admin Panel Customization based on Mégane's feedback * Update docs/developer-docs/latest/developer-resources/database-apis-reference/query-engine/bulk-operations.md * Add a few tiny enhancements to REST API * Create a Content API section * Improve Models section * Update 'key' vs 'parameter' wording to make its usage consistent * Update GraphQL with JS feedback * Update Plugins (intro, development, extension) with Pierre N's feedback * Update GraphQL with JS feedback * Update Plugins (intro, development, extension) with Pierre N's feedback * Update docs/developer-docs/latest/setup-deployment-guides/configurations.md Co-authored-by: meganelacheny <[email protected]> * Fix Winston vs. Pino Co-authored-by: DMehaffy <[email protected]> * Add TODO about "add admin jwt config option" * Update TODO (field-related actions in GraphQL custom) + path * Add yaml for plugins extension * Add TODOs and fix stuff with soupette's feedback * Convert strapi to prerequisites callout * Add queries & mutations explanation * Update Admin Panel files based on soup's & Mégane's feedback * Update Admin Panel files based on soup's & Mégane's feedback * Add code example to extend translations (admin panel customization) * Fix path to server config docs * Don't have sections without a proper `path` greyed out * Move `title` before `collapsable` in dev sidebar config * Move Development before Strapi plugins in sidebar * Enhance Plugins development & intro + create plugins configuration docs * Update plugins extension section with Mégane's & Pierre N.'s feedbacks * Add documentation for register() function found in src/index.js * Simplify plugins auto-discovery wording * Fix code syntaxes in Server API for Plugins * Refine plugins extensions within src/index.js * Add TODO about upcoming destroy() function in src/index.js * Refine Server API with Mégane's feedback * Update Plugins extension based on Mégane's feedback * Update project structure * Add comment to src/index.js in project structure * Add more tweaks to project structure * Rename Database APIs reference and include them in a simple "APIs reference" * Improve Query Engine API and REST API docs * Fix syntaxes in controllers documentation * Enhance GraphQL docs based on JS's feedback * Rename global strapi API reference's h1 * Move Plugin API reference to APIs reference section in sidebar * Remove old, empty content-api file * Remove old, empty backend-customization file * Remove old, empty mondodb database guide * Fix broken links in admin-customization and plugins-extension * [v4] Dev Docs - Reworked "Configurations" section (#429) * Unify order of optional configurations in text and sidebar * Remove database ORM customization from config > optional > functions * Rename Bookshelf tab to SQL in config > required > databases * Fix more broken links * Add mini-intro for GraphQL API * Add mini-intro for GraphQL API * Add mini-intro for REST API + fix related items * Add mini-intro for REST API + fix related items * Remove unused heading in plugins extension * Wording: Content API → REST & GraphQL * Fix links in project structure file * Wording: Content API → REST & GraphQL * Remove unused heading in plugins extension * Delete unused content-api.md * Remove unused comment after file splitting * Remove comments * Delete hooks * Fix plugins-extension (paths, code example code, heading) * Add code example for field actions in GraphQL custom * Fix broken links * Update configuration > optional > functions with bootstrap and register * Add temporary beta badge in nav bar * Update beta badge color * Fix more broken links after merge Co-authored-by: meganelacheny <[email protected]> Co-authored-by: DMehaffy <[email protected]> * Remove v4 beta as maybe it makes Vercel fail 🤷 * Remove beta "badge" * Restore proper GraphQL docs * Rename Plugin API → APIs reference in sidebar * Place note about starter file structure at the top of the file * Update file-structure links to make them work on docs*.strapi.io URLs * Fix src/admin path in admin custom * Use "Docs beta" logo * Add v4 in getting started intro page title * Add link to v3 docs in navbar * Optimize beta logo * Use new uid syntax in Query Engine API code examples * Fix some paths * Dev/hotfixes next (#442) * Add plugins config in TOC * Fix path in admin customization * Fix title of Admin Panel API * Update sidebar: 'Plugins APIs reference' → 'Plugin API' * Add plugins to list of optional config in config intro * Update 'entities' → 'entries' in Query Engine API intro * Update intro to Query Engine > Filtering * Replace beta logo with better version * Update pagination for Query Engine API * Add mini intros in Query Engine API ordering * [v4] Fix typo in injection zone API reference (#447) * Fix npm command in admin customization deployment instructions * Fix plugin extension example * Fix REST API filters name + definition (#472) * [v4] Dev docs - Entity Service API (#445) * Draft Entity Service docs * Improve Entity Service API docs * Fix bad logo path * Retrieve prev. SEO title for QE filters * Update docs/developer-docs/latest/developer-resources/database-apis-reference/entity-service/populate.md * Add missing extra id parameter Co-authored-by: Alexandre BODIN <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/entity-service/crud.md Co-authored-by: Alexandre BODIN <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/entity-service/crud.md Co-authored-by: Alexandre BODIN <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/entity-service/crud.md Co-authored-by: Alexandre BODIN <[email protected]> * Batch update the UID structure Will change the `articles` to `article` in a follow up commit Co-authored-by: Pierre Noël <[email protected]> * Fix UID pluralization * Use publishDate instead of id in an example Co-authored-by: DMehaffy <[email protected]> * Use desc instead of asc Co-authored-by: DMehaffy <[email protected]> * Only partial update() * Remove filters and sort as they're not supported by findOne() * Used createdAt instead of title in sort example * Remove needless filters attribute in update example * True, semantic * Use createdAt with $and operator example * Add proper fields, sort and populate in EntServ populate example * Simplify delete example * Wording * Add tip for nestable logical operators * Update nin → notIn * Add notContains, containsi and notContainsi * Fix `$attribute-name` → `attribute-name` * Enhance with Mégane's feedback Co-authored-by: Alexandre BODIN <[email protected]> Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Noël <[email protected]> * [v4] next-3 release (#478) * [dev/latest-guides-auth-request] Fixed grammatical error (#431) * Fixed grammatical error * Fixed to better match style guide Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * npm build command doesn't work. Use npm run build (#440) See: https://stackoverflow.com/questions/29939697/npm-build-doesnt-run-the-script-named-build-in-package-json This should also be updated across the docs wherever its found. Maybe I'll go hunting soon if this one gets merged (first time contributor here 😊) * Update note in v3 migration guides (#449) * fix publicationState filter docs (#425) Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * [v4] Dev docs: Shorter backend customizations intro (#458) * WIP * Add a short backend customization introduction * Update yaml title Co-authored-by: DMehaffy <[email protected]> Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: cron jobs (#463) * Move CRON tasks out of functions docs & refactor structure * Update: is → should be in prereq. * Update docs/developer-docs/latest/setup-deployment-guides/configurations/optional/cronjobs.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/optional/cronjobs.md Co-authored-by: DMehaffy <[email protected]> Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: CLI updates (#467) * Add the new interactive `strapi generate` + all the `:list` commands * Add strapi watch-admin * Add links to docs entries for :list commands * [v4] Dev docs updates to services (#453) * Update services documentation * Delete unused backend-customization.md * Update intro to make it consistent with other backend custom. docs * Add link to strapi generate CLI docs * [v4] Dev docs: Add API token documentation (#457) * Add API token documentation * Delete file(s) * Add example to full server config * Revert changes to REST API API token is passed in the header * Update how the API token is passed along with the request * Fix typo: unneeded space * `apiToken`: camelCase + move to minimal config (Note: will be moved to ./config/admin.js in another PR) * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: Update command name for template generation (#474) * Update command name for template generation throughout all docs * Update header * [v4] Dev docs updates to routes (#450) * Update routes file in backend customization * Improve routes content and wording * Fix syntax (JSON → JS) * Delete routing.md (Now using routes) * Delete backend-customization.md * Consists in → consists of Co-authored-by: DMehaffy <[email protected]> * Add missing forward slash in path Co-authored-by: DMehaffy <[email protected]> * Add missing forward slash in path Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash in path 😅 Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash in path, again 😅 Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash 😅 🙈 Co-authored-by: DMehaffy <[email protected]> * Remove question comment, no `next` in policies * Update based on Mégane's feedback Co-authored-by: DMehaffy <[email protected]> * Clarify with policyContext * [v4] Dev docs: Add destroy() + update functions (#462) * Add destroy() docs * Reword other functions docs for consistency + add cross-links * Add missing - * Break down destroy() use cases into a bullet list * Include destroy() in src/index.js comment in project structure * Move loading env vars to register * [v4] Dev docs: Move admin configuration out of server configuration (#461) * Update configuration intro * Add file to project structure docs * Add admin panel config to sidebar TOC * Add admin-panel configuration docs * Update server configuration * Update admin panel customization * Update SSO docs * Fix typo comman → command * Add TODO for SEO * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/admin-panel.md Co-authored-by: Alexandre BODIN <[email protected]> * Use env in example for API token salt Co-authored-by: Alexandre BODIN <[email protected]> * [v4] Dev docs updates to policies (#451) * Add policies subfolder in src/plugins folder in project structure docs * Delete backend-customization.md * Add another missing forward slash in path 😅 Co-authored-by: DMehaffy <[email protected]> * Remove unused link * Update link to plugin policies docs in project structure * Remove caution callout about performance impacts * Add link to strapi generate CLI docs * Remove TODO about strpai generate * Remove useless example * Tech writing improvements * Mention config object for policies * Update docs/developer-docs/latest/development/backend-customization/policies.md Co-authored-by: Alexandre BODIN <[email protected]> * Update docs/developer-docs/latest/development/backend-customization/policies.md * (WIP) Fix policies examples TODO: Include changes of this PR: https://github.com/strapi/strapi/pull/11478 Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Alexandre BODIN <[email protected]> * Update after policies refactoring (#477) * [v4] Dev docs: Add error handling (#460) * Create error handling documentation * Add links in REST and GraphQL API docs * Add entry in sidebar TOC * Make h3 titles consistent * Improve wording * Update docs/developer-docs/latest/developer-resources/error-handling.md Co-authored-by: Pierre Noël <[email protected]> * Update JSONs * Improve based on Mégane's and Pierre N's feedback * Update with Pierre N feedback Co-authored-by: Pierre Noël <[email protected]> * [v4] Dev docs: Add more GraphQL customizations: auth, policies, middlewares (#459) * Update GraphQL customization example — now happens in src/index.js * Add missing link to "extending the schema" header * Start describing resolversConfig, with authorization options * Be even more explicit on the auth example * Add policies to GraphQL resolversConfig * Add middlewares to GraphQL resolversConfig * Add header links * Add TODO for TOC improvements (h5 😅) * Adding more header links * Fixing some paths in code examples to make sure @derrickmehaffy is happy 😂 * Fix links * Update docs/developer-docs/latest/plugins/graphql.md Co-authored-by: Jean-Sébastien Herbaux <[email protected]> * Update based on JS' feedback * Improve wording on `auth: false` and `scope` Co-authored-by: Jean-Sébastien Herbaux <[email protected]> * [v4] Dev docs: Update i18n with new REST & GraphQL syntax (#466) * Update REST API part * Update GraphQL API part * Update i18n REST TODO: double-check examples and explanations * Update based on Pierre N's feedback * [v4] Dev docs updates to controllers (#452) * Update controllers documentation * Remove sidebarDepth in yaml as default level (2) is enough * Delete unused backend-customization.md file * Add link to plugin controllers in project structure docs * Re-introduce core controllers examples Note: Code examples are not usable as-is, will be reworked with devs. * Go a level deeper in sidebar * Simplify controller usage section * Add link to strapi generate CLI docs * Improve core controllers intro based on Pierre N's feedback * Improve some controllers explanations * Add a temporary caution while controllers are under rework * [v4] Dev docs updates to middlewares (#455) * Move middlewares from optional to required configurations * Fix path and file name in project structure docs * Update middlewares configuration (missing full config reference for internal middlewares) * Enhance middlewares configuration * Add middleware customization * Add commented out node modules paragraph Not sure we should keep it though * Add mandatory configuration step to middlewares implementation * Add `strapi` to middleware implementation example * Update custom timer middleware example * Add almost all internal middlewares config. reference * Add public middleware config reference * WIP: Complete config tables * Add editing enhancements * Update some tables * Delete backend-customization.md * Update link to middlewares config * Fix links * Fix again (wrong link in prev. commit 😅 ) * Remove comment about strapi generate missing middlewares * Add link to strapi generate CLI docs * Improve based on devs feedback * Add mentions to plugins * Improve based on Pierre N's and Alex's feedback * Clarify built-in middlewares should not be removed * [v4] User Guide: API token documentation (#464) * Write documentation for API tokens settings * Document API tokens CRUD actions in Admin roles * Improve API token doc * Improve after reviews Co-authored-by: Pierre Wizla <[email protected]> * Update controllers code examples * Add callout about Error catching guide * Disable API token and count with GraphQL guides * Fix broken links (1 on 2) * Fix broken links (2 on 2) Co-authored-by: Brendan Laney <[email protected]> Co-authored-by: Chizaram Nwazuo <[email protected]> Co-authored-by: DMehaffy <[email protected]> Co-authored-by: petr-hajek <[email protected]> Co-authored-by: Alexandre BODIN <[email protected]> Co-authored-by: Pierre Noël <[email protected]> Co-authored-by: Jean-Sébastien Herbaux <[email protected]> Co-authored-by: meganelacheny <[email protected]> * Update spelling: Content-Types Builder → Content-Type Builder (#479) * Fix auth: scope snippet in GraphQL custom * Add GraphQL defaultLimit/maxLimit docs in config/plugins.js (#480) * [v4] Clean up todos & question comments (#481) * Clean up TODOs * Clean up question comments * Fix admin panel config link in project structure * Update services.md * Update controllers.md * Add example on how to populate dynamic zones * Fix populate dynamic zone * [v4] Refactor Proxy documentation (#475) * [dev/latest-guides-auth-request] Fixed grammatical error (#431) * Fixed grammatical error * Fixed to better match style guide Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * npm build command doesn't work. Use npm run build (#440) See: https://stackoverflow.com/questions/29939697/npm-build-doesnt-run-the-script-named-build-in-package-json This should also be updated across the docs wherever its found. Maybe I'll go hunting soon if this one gets merged (first time contributor here 😊) * Update note in v3 migration guides (#449) * fix publicationState filter docs (#425) Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * [v4] Dev docs: Shorter backend customizations intro (#458) * WIP * Add a short backend customization introduction * Update yaml title Co-authored-by: DMehaffy <[email protected]> Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: cron jobs (#463) * Move CRON tasks out of functions docs & refactor structure * Update: is → should be in prereq. * Update docs/developer-docs/latest/setup-deployment-guides/configurations/optional/cronjobs.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/optional/cronjobs.md Co-authored-by: DMehaffy <[email protected]> Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: CLI updates (#467) * Add the new interactive `strapi generate` + all the `:list` commands * Add strapi watch-admin * Add links to docs entries for :list commands * [v4] Dev docs updates to services (#453) * Update services documentation * Delete unused backend-customization.md * Update intro to make it consistent with other backend custom. docs * Add link to strapi generate CLI docs * [v4] Dev docs: Add API token documentation (#457) * Add API token documentation * Delete file(s) * Add example to full server config * Revert changes to REST API API token is passed in the header * Update how the API token is passed along with the request * Fix typo: unneeded space * `apiToken`: camelCase + move to minimal config (Note: will be moved to ./config/admin.js in another PR) * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: Update command name for template generation (#474) * Update command name for template generation throughout all docs * Update header * [v4] Dev docs updates to routes (#450) * Update routes file in backend customization * Improve routes content and wording * Fix syntax (JSON → JS) * Delete routing.md (Now using routes) * Delete backend-customization.md * Consists in → consists of Co-authored-by: DMehaffy <[email protected]> * Add missing forward slash in path Co-authored-by: DMehaffy <[email protected]> * Add missing forward slash in path Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash in path 😅 Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash in path, again 😅 Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash 😅 🙈 Co-authored-by: DMehaffy <[email protected]> * Remove question comment, no `next` in policies * Update based on Mégane's feedback Co-authored-by: DMehaffy <[email protected]> * Clarify with policyContext * [v4] Dev docs: Add destroy() + update functions (#462) * Add destroy() docs * Reword other functions docs for consistency + add cross-links * Add missing - * Break down destroy() use cases into a bullet list * Include destroy() in src/index.js comment in project structure * Move loading env vars to register * [v4] Dev docs: Move admin configuration out of server configuration (#461) * Update configuration intro * Add file to project structure docs * Add admin panel config to sidebar TOC * Add admin-panel configuration docs * Update server configuration * Update admin panel customization * Update SSO docs * Fix typo comman → command * Add TODO for SEO * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/admin-panel.md Co-authored-by: Alexandre BODIN <[email protected]> * Use env in example for API token salt Co-authored-by: Alexandre BODIN <[email protected]> * Completely refactor Nginx proxy guide * Work in progress HAProxy & Caddy + Moved some stuff to snippets * Finish refactoring all guides * Update services intro to match `next` content * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/nginx-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/nginx-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/nginx-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/admin-redirect.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/nginx-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/snippets/strapi-server.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/haproxy-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/nginx-proxy.md * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/nginx-proxy.md * Tech writing improvements * Update docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/caddy-proxy.md * More TW improvements Co-authored-by: Brendan Laney <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Chizaram Nwazuo <[email protected]> Co-authored-by: petr-hajek <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Alexandre BODIN <[email protected]> * Fix Github URL for theme in Admin Panel customization * Fix conflict in caddy-proxy.md * Add cross-reference links in dev docs & user guide (#491) * Update Admin plugin API (#494) Signed-off-by: soupette <[email protected]> * Remove global Strapi API reference (#495) * Fix indentation in backend customization > middlewares * [v4] Fix SSO paths (#497) * Fix path for config files (now in admin config) * Update heading level * Add missing paths in code examples * Update docs/developer-docs/latest/setup-deployment-guides/configurations/optional/sso.md * Update docs/developer-docs/latest/setup-deployment-guides/configurations/optional/sso.md * [v4] Fix all DB examples (#468) * [dev/latest-guides-auth-request] Fixed grammatical error (#431) * Fixed grammatical error * Fixed to better match style guide Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * npm build command doesn't work. Use npm run build (#440) See: https://stackoverflow.com/questions/29939697/npm-build-doesnt-run-the-script-named-build-in-package-json This should also be updated across the docs wherever its found. Maybe I'll go hunting soon if this one gets merged (first time contributor here 😊) * Update note in v3 migration guides (#449) * fix publicationState filter docs (#425) Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * [v4] Dev docs: Shorter backend customizations intro (#458) * WIP * Add a short backend customization introduction * Update yaml title Co-authored-by: DMehaffy <[email protected]> Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: cron jobs (#463) * Move CRON tasks out of functions docs & refactor structure * Update: is → should be in prereq. * Update docs/developer-docs/latest/setup-deployment-guides/configurations/optional/cronjobs.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/optional/cronjobs.md Co-authored-by: DMehaffy <[email protected]> Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: CLI updates (#467) * Add the new interactive `strapi generate` + all the `:list` commands * Add strapi watch-admin * Add links to docs entries for :list commands * [v4] Dev docs updates to services (#453) * Update services documentation * Delete unused backend-customization.md * Update intro to make it consistent with other backend custom. docs * Add link to strapi generate CLI docs * [v4] Dev docs: Add API token documentation (#457) * Add API token documentation * Delete file(s) * Add example to full server config * Revert changes to REST API API token is passed in the header * Update how the API token is passed along with the request * Fix typo: unneeded space * `apiToken`: camelCase + move to minimal config (Note: will be moved to ./config/admin.js in another PR) * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Co-authored-by: DMehaffy <[email protected]> * [v4] Dev docs: Update command name for template generation (#474) * Update command name for template generation throughout all docs * Update header * [v4] Dev docs updates to routes (#450) * Update routes file in backend customization * Improve routes content and wording * Fix syntax (JSON → JS) * Delete routing.md (Now using routes) * Delete backend-customization.md * Consists in → consists of Co-authored-by: DMehaffy <[email protected]> * Add missing forward slash in path Co-authored-by: DMehaffy <[email protected]> * Add missing forward slash in path Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash in path 😅 Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash in path, again 😅 Co-authored-by: DMehaffy <[email protected]> * Add another missing forward slash 😅 🙈 Co-authored-by: DMehaffy <[email protected]> * Remove question comment, no `next` in policies * Update based on Mégane's feedback Co-authored-by: DMehaffy <[email protected]> * Clarify with policyContext * [v4] Dev docs: Add destroy() + update functions (#462) * Add destroy() docs * Reword other functions docs for consistency + add cross-links * Add missing - * Break down destroy() use cases into a bullet list * Include destroy() in src/index.js comment in project structure * Move loading env vars to register * [v4] Dev docs: Move admin configuration out of server configuration (#461) * Update configuration intro * Add file to project structure docs * Add admin panel config to sidebar TOC * Add admin-panel configuration docs * Update server configuration * Update admin panel customization * Update SSO docs * Fix typo comman → command * Add TODO for SEO * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/admin-panel.md Co-authored-by: Alexandre BODIN <[email protected]> * Use env in example for API token salt Co-authored-by: Alexandre BODIN <[email protected]> * Fix all DB example configs excluding pool options Signed-off-by: Derrick Mehaffy <[email protected]> * add notes to the objects and add debug example to sqlite * Finish refactoring database based on alex feedback Signed-off-by: Derrick Mehaffy <[email protected]> * remove tab that isn't needed, add headers * Update services intro to match latest `next` content * Re-add update SEO tag as it's handled in another PR * Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/databases.md * add forcedMigration option Co-authored-by: Brendan Laney <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Chizaram Nwazuo <[email protected]> Co-authored-by: petr-hajek <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Alexandre BODIN <[email protected]> * Explicit the difference between `populate=*` and `[populate]=*` * Move tip about using qs higher * Move caution about filters to filters section * Fix server config conflict * [v4] next-4 release (#500) * [v4] Snippet for community contributions for integration guides (#496) * Add snippet asking community contributions for integration guides * Update wording of snippet * [v4] Various Misc fixes to documentation (#483) * Minor fixes * more small fixes * pr feedback * fix api config defaults * [v4] Quick Start Guide updates (part. 1 - Hands-on) (#493) * Rework the "What to do next" sections * Restore medium-zoom plugin feature * Update first admin panel screenshot * Update wording, screenshots and GIFs for Hands-on path * Update capitalization for "field" * Add `@latest` tag Or else it will try to use the local cached version of create-strapi-app * Update formatting for UI in Hands-on so we're consistent with the user guide TODO: add icons once merged with Mégane's PR * Fix pluralized UI wordings * Add latest user docs folder content * Update admin roles + field selection + plugins list screenshots * Delete admin panel screenshot from Documentation plugin doc * Fix path in Update Strapi doc * Update alt text on QSG Hands-on screenshots * Remove misplaced screenshot * De-index some guides * Add snippet for deployment guides contributions * Update login page screenshot with SSO * Fix merge (SSO, API token…) with user docs * Add API tokens screenshot in user guide * Fix wording in a "Configuring view of content-type" table * Add missing contribution snippet to "Custom data response" guide * [v4] Controllers, services & routes updates (factories) (#488) * update core example * Rewrite intro sentence * collection type examples + other fixes * rewrite another example + singletypes * Reword tip * add cli command at bottom * Improve tech writing * Improve example * add additional comment to make it clear * Fix a few things in controllers and update service examples * forgot services path * Rewrite router docuementation * Tech writing improvements * Use proper "action" wording * Update wording Co-…
1 parent ba3423d commit bb9a686

File tree

15 files changed

+47
-33
lines changed

15 files changed

+47
-33
lines changed

‎.algolia/docsearch.config.json‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
{
22
"index_name": "documentation",
3-
"start_urls": ["https://docs.strapi.io"],
3+
"start_urls": [
4+
"https://docs.strapi.io"
5+
],
46
"selectors": {
57
"lvl0": {
6-
"selector": "//h1/text()",
8+
"selector": "(//*[contains(@class, 'sidebar-heading open')])[1]",
79
"type": "xpath",
810
"global": true
911
},
1012
"lvl1": {
11-
"selector": "//h2/text()",
13+
"selector": "//h1/text()",
1214
"type": "xpath",
1315
"global": true
1416
},
1517
"lvl2": {
16-
"selector": "//h3/text()",
18+
"selector": "/html/head/meta[@name='description']/@content",
1719
"type": "xpath",
1820
"global": true
1921
},
20-
"lvl3": {
21-
"selector": "/html/head/meta[@name='description']/@content",
22+
"lvl4": {
23+
"selector": "//h2/text()",
2224
"type": "xpath",
2325
"global": true
2426
},
@@ -30,8 +32,12 @@
3032
}
3133
},
3234
"strip_chars": " .,;:#",
33-
"stop_urls": ["https://docs.strapi.io/developer-docs/latest/update-migration-guides/migration-guides"],
35+
"stop_urls": [
36+
"https://docs.strapi.io/developer-docs/latest/update-migration-guides/migration-guides"
37+
],
3438
"custom_settings": {
35-
"attributesForFaceting": ["lang"]
39+
"attributesForFaceting": [
40+
"lang"
41+
]
3642
}
37-
}
43+
}

‎docs/.vuepress/config.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -808,8 +808,9 @@ module.exports = {
808808
docsDir: 'docs',
809809
docsBranch: 'main',
810810
algolia: {
811-
apiKey: 'a93451de224096fb34471c8b8b049de7',
812-
indexName: 'strapi',
811+
appId: '9FTY6J9E4X',
812+
apiKey: 'cf49c82a1865df2618a3d89e18657051',
813+
indexName: 'documentation',
813814
},
814815
editLinks: true,
815816
editLinkText: 'Improve this page',

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: CLI - Strapi Developer Docs
33
description: Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds.
4-
canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/cli.html
4+
canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html
55
---
66

77
# Command Line Interface (CLI)
@@ -254,6 +254,10 @@ Display a list of all the available hooks.
254254
strapi hooks:list
255255
```
256256

257+
## strapi controllers:list
258+
259+
Display a list of all the registered [controllers](/developer-docs/latest/development/backend-customization/controllers.md).
260+
257261
## strapi services:list
258262

259263
Display a list of all the registered [services](/developer-docs/latest/development/backend-customization/services.md).

‎docs/developer-docs/latest/developer-resources/content-api/content-api.md‎

Whitespace-only changes.

‎docs/developer-docs/latest/developer-resources/content-api/integrations/graphql.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Get started with GraphQL - Strapi Developer Docs
3-
description: Build powerful applications using Strapi, the leading open-source headless cms and GraphQL.
3+
description: Use the GraphQL plugin in your Strapi project to fetch and mutate your content.
44
canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/content-api/integrations/graphql.html
55
---
66

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ To disable notifications about new Strapi releases, set the `config.notification
245245
To extend the theme, use the `config.theme` key.
246246

247247
::: strapi Strapi Parts! theme
248-
The default [Strapi Parts! theme](https://github.com/strapi/parts/tree/master/packages/strapi-parts/src/themes) defines various theme-related keys (shadows, colors…) that can be updated through the `config.theme` key in `./admin/src/app.js`.
248+
The default [Strapi Parts! theme](https://github.com/strapi/design-system/tree/develop/packages/strapi-design-system/src/themes) defines various theme-related keys (shadows, colors…) that can be updated through the `config.theme` key in `./admin/src/app.js`.
249249
:::
250250

251251
<!-- TODO: maybe provide a theme extension example once design system is ready? -->

‎docs/developer-docs/latest/development/backend-customization/controllers.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ A new controller can be implemented:
2929

3030
const { createCoreController } = require('@strapi/strapi').factories;
3131

32-
module.exports = createCoreController('api::restaurant.restaurant', ({ strapi }) => {
32+
module.exports = createCoreController('api::restaurant.restaurant', ({ strapi }) => ({
3333
// Method 1: Creating an entirely custom action
3434
async exampleAction(ctx) {
3535
try {
@@ -63,7 +63,7 @@ module.exports = createCoreController('api::restaurant.restaurant', ({ strapi })
6363

6464
return this.transformResponse(sanitizedEntity);
6565
}
66-
};
66+
});
6767
```
6868
6969
Each controller action can be an `async` or `sync` function.

‎docs/developer-docs/latest/development/backend-customization/services.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To manually create a service, export a factory function that returns the service
2929

3030
const { createCoreService } = require('@strapi/strapi').factories;
3131

32-
module.exports = createCoreService('api::restaurant.restaurant', ({ strapi }) => {
32+
module.exports = createCoreService('api::restaurant.restaurant', ({ strapi }) => ({
3333
// Method 1: Creating an entirely custom service
3434
async exampleService(...args) {
3535
let response = { okay: true }
@@ -58,7 +58,7 @@ module.exports = createCoreService('api::restaurant.restaurant', ({ strapi }) =>
5858
async findOne(entityId, params = {}) {
5959
return strapi.entityService.findOne('api::restaurant.restaurant', entityId, this.getFetchParams(params));
6060
}
61-
};
61+
});
6262
```
6363
6464
::: strapi Entity Service API
@@ -84,8 +84,8 @@ const transporter = nodemailer.createTransport({
8484
},
8585
});
8686

87-
module.exports = createCoreService('api::restaurant.restaurant', ({ strapi }) => {
88-
send(from, to, subject, text) => {
87+
module.exports = createCoreService('api::restaurant.restaurant', ({ strapi }) => ({
88+
send(from, to, subject, text) {
8989
// Setup e-mail data.
9090
const options = {
9191
from,
@@ -97,17 +97,17 @@ module.exports = createCoreService('api::restaurant.restaurant', ({ strapi }) =>
9797
// Return a promise of the function that sends the email.
9898
return transporter.sendMail(options);
9999
},
100-
};
100+
});
101101
```
102102
103103
The service is now available through the `strapi.service('api::email.email').send(...args)` global variable. It can be used in another part of the codebase, like in the following controller:
104104
105105
```js
106106
// path: ./src/api/user/controllers/user.js
107107

108-
module.exports = createCoreController('api::restaurant.restaurant', ({ strapi }) => {
108+
module.exports = createCoreController('api::restaurant.restaurant', ({ strapi }) => ({
109109
// GET /hello
110-
async signup(ctx) => {
110+
async signup(ctx) {
111111
const { userData } = ctx.body;
112112

113113
// Store the new user in database.
@@ -121,7 +121,7 @@ module.exports = createCoreController('api::restaurant.restaurant', ({ strapi })
121121
ok: true,
122122
});
123123
},
124-
};
124+
});
125125
```
126126
127127
::::

‎docs/developer-docs/latest/plugins/i18n.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,6 @@ yarn strapi install i18n
4848

4949
## Usage with the REST API
5050

51-
<!-- TODO: double-check examples and explanations -->
52-
5351
The i18n plugin adds new features to the [REST API](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md):
5452

5553
- a new [`locale`](#getting-localized-entries-with-the-locale-parameter) parameter to fetch content only for a specified locale
@@ -266,7 +264,6 @@ This request:
266264

267265
::: response Example response
268266

269-
<!-- TODO: check example reponse -->
270267
```json
271268
{
272269
"id": 9,
@@ -303,7 +300,6 @@ This request:
303300
`POST http://localhost:1337/api/homepage/localizations`
304301

305302
```json
306-
<!-- TODO: check example request -->
307303
{
308304
"title": "Bienvenue sur FoodAdvisor !",
309305
"locale": "fr",
@@ -315,7 +311,6 @@ This request:
315311
::: response Example response
316312

317313
```json
318-
<!-- TODO: check example response -->
319314
{
320315
"id": 2,
321316
"title": "Bienvenue sur FoodAdvisor!",

‎docs/developer-docs/latest/setup-deployment-guides/configurations/optional/api-tokens.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: API tokens - Strapi Developer Docs
3-
description:
3+
description: Using API tokens allows executing a request on Strapi's REST API endpoints as an authenticated user.
44
---
55

66
# API tokens

0 commit comments

Comments
 (0)