From 331b8fe8a3361e99d94e62c460961f1cd02383b2 Mon Sep 17 00:00:00 2001 From: Mariusz Wachowski Date: Tue, 22 Oct 2019 17:06:21 +0200 Subject: [PATCH 01/27] update PL translations --- .../admin/src/translations/pl.json | 35 +++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/packages/strapi-admin/admin/src/translations/pl.json b/packages/strapi-admin/admin/src/translations/pl.json index 6052774d0b..53316a65fc 100644 --- a/packages/strapi-admin/admin/src/translations/pl.json +++ b/packages/strapi-admin/admin/src/translations/pl.json @@ -2,6 +2,7 @@ "Analytics": "Analityka", "Content Manager": "Treści", "Content Type Builder": "Modele", + "Documentation": "Dokumentacja", "Email": "Email", "Files Upload": "Upload plików", "HomePage.notification.newsLetter.success": "Pomyślnie zapisano do biuletynu", @@ -52,6 +53,8 @@ "app.components.InputFileDetails.originalName": "Oryginalna nazwa:", "app.components.InputFileDetails.remove": "Usuń ten plik", "app.components.InputFileDetails.size": "Rozmiar:", + "app.components.InstallPluginPage.Download.title": "Pobieranie...", + "app.components.InstallPluginPage.Download.description": "Pobranie i instalacja wtyczki może zająć kilka sekund.", "app.components.InstallPluginPage.InputSearch.label": " ", "app.components.InstallPluginPage.InputSearch.placeholder": "Wyszukaj wtyczkę... (np: authentication)", "app.components.InstallPluginPage.description": "Rozszerz swoją aplikację bez wysiłku", @@ -65,6 +68,8 @@ "app.components.InstallPluginPopup.navLink.faq": "faq", "app.components.InstallPluginPopup.navLink.screenshots": "Zrzuty ekranu", "app.components.InstallPluginPopup.noDescription": "Brak dostępnego opisu", + "app.components.LeftMenuFooter.documentation": "Dokumentacja", + "app.components.LeftMenuFooter.help": "Pomoc", "app.components.LeftMenuFooter.poweredBy": "Dumnie wspierane przez ", "app.components.LeftMenuLinkContainer.configuration": "Konfiguracje", "app.components.LeftMenuLinkContainer.general": "Ogólne", @@ -75,18 +80,26 @@ "app.components.ListPluginsPage.description": "Lista zainstalowanych wtyczek w projekcie.", "app.components.ListPluginsPage.helmet.title": "Lista wtyczek", "app.components.ListPluginsPage.title": "Wtyczki", + "app.components.Logout.admin": "Zarządzaj administratorami", "app.components.Logout.profile": "Profil", "app.components.Logout.logout": "Wyloguj", "app.components.NotFoundPage.back": "Powrót do strony głównej", "app.components.NotFoundPage.description": "Nie znaleziono", "app.components.Official": "Oficjalna", + "app.components.Onboarding.label.completed": "% ukończono", + "app.components.Onboarding.title": "Filmy 'Jak Zacząć'", "app.components.PluginCard.Button.label.download": "Pobierz", "app.components.PluginCard.Button.label.install": "Zainstalowana", "app.components.PluginCard.Button.label.support": "Wesprzyj nas", "app.components.PluginCard.compatible": "Kompatybilna z twoją aplikacją", "app.components.PluginCard.compatibleCommunity": "Kompatybilna ze społecznością", "app.components.PluginCard.more-details": "Więcej szczegółów", + "app.components.PluginCard.PopUpWarning.install.impossible.autoReload.needed": "Funkcja autoReload musi być włączona. Uruchom aplikację używając polecenia `yarn develop`.", + "app.components.PluginCard.PopUpWarning.install.impossible.environment": "Z powodów bezpieczeństwa wtyczka może być pobrana tylko w środowisku developerskim.", + "app.components.PluginCard.PopUpWarning.install.impossible.confirm": "Zrozumiałem!", + "app.components.PluginCard.PopUpWarning.install.impossible.title": "Pobieranie jest niemożliwe", "app.components.PluginCard.price.free": "Darmowa", + "app.components.PluginCard.settings": "Ustawienia", "app.components.listPlugins.button": "Dodaj nową wtyczkę", "app.components.listPlugins.title.none": "Żadna wtyczka nie jest zainstalowana", "app.components.listPlugins.title.plural": "{number} wtyczek jest zainstalowanych", @@ -95,6 +108,7 @@ "app.utils.SelectOption.defaultMessage": " ", "app.utils.defaultMessage": " ", "app.utils.placeholder.defaultMessage": " ", + "components.AutoReloadBlocker.description": "Uruchom Strapi z jedną z poniższych komend:", "components.AutoReloadBlocker.header": "Do tej wtyczki wymagana jest funkcja przeładowania.", "components.ErrorBoundary.title": "Coś poszło nie tak...", "components.Input.error.attribute.key.taken": "Ta wartość już istnieje", @@ -111,9 +125,12 @@ "components.Input.error.validation.minSupMax": "Nie może być większa", "components.Input.error.validation.regex": "Wartość nie jest zgodna z wymaganym wzorcem.", "components.Input.error.validation.required": "Wpisanie wartości dla tego atrybutu jest wymagane.", + "components.InputSelect.option.placeholder": "Wybierz tutaj", "components.ListRow.empty": "Nie ma żadnych danych do wyświetlenia.", "components.OverlayBlocker.description": "Używasz funkcjonalności która wymaga ponownego uruchomienia serwera. Poczekaj proszę aż aplikacja znów będzie aktywna.", + "components.OverlayBlocker.description.serverError": "Serwer powinien zostać zrestartowany, sprawdź swoje logi w terminalu.", "components.OverlayBlocker.title": "Oczekiwanie na ponowne uruchomienie...", + "components.OverlayBlocker.title.serverError": "Ponowne uruchomienie trwa dłużej niż oczekiwano", "components.PageFooter.select": "elementów na stronę", "components.ProductionBlocker.description": "Ze względów bezpieczeństwa wtyczka jest wyłączona w innych środowiskach.", "components.ProductionBlocker.header": "Ta wtyczka jest dostępna tylko w wersji deweloperskiej.", @@ -138,7 +155,18 @@ "notification.error": "Wystąpił błąd", "notification.error.layout": "Nie można pobrać układu", "request.error.model.unknown": "Ten model nie istnieje", + "app.utils.delete": "Usuń", + "HomePage.helmet.title": "Strona Główna", + "HomePage.welcome.congrats": "Gratulacje!", + "HomePage.welcome.congrats.content": "Jesteś zalogowany jako pierwszy administrator. Aby odkryć zaawansowane funkcje oferowane przez Strapi,", + "HomePage.welcome.congrats.content.bold": "zalecamy utworzenie pierwszego Modelu.", + "HomePage.community": "Dołącz do społeczności", + "HomePage.roadmap": "Zobacz harmonogram", + "HomePage.greetings": "Cześć {name}!", + "Auth.advanced.allow_register": "", + "Auth.privacy-policy-agreement.terms": "warunki", + "Auth.privacy-policy-agreement.policy": "polityka prywatności", "Auth.form.button.forgot-password": "Wyślij e-mail", "Auth.form.button.forgot-password.success": "Wyślij ponownie", "Auth.form.button.login": "Zaloguj się", @@ -164,7 +192,6 @@ "Auth.form.forgot-password.email.label": "Email", "Auth.form.forgot-password.email.label.success": "E-mail wysłany z powodzeniem do", "Auth.form.forgot-password.email.placeholder": "jannowak@gmail.com", - "Auth.form.header.forgot-password": "strapi", "Auth.form.header.login": "strapi", "Auth.form.header.register": "Witaj!", @@ -178,11 +205,15 @@ "Auth.form.register.confirmPassword.label": "Potwierdzenie hasła", "Auth.form.register.email.label": "Email", "Auth.form.register.email.placeholder": "jannowak@gmail.com", + "Auth.form.register.news.label": "Informuj mnie na bieżąco o nowych funkcjach i nadchodzących ulepszeniach (wybór oznacza akceptację {terms} i {policy}).", "Auth.form.register.password.label": "Hasło", "Auth.form.register.username.label": "Użytkownik", "Auth.form.register.username.placeholder": "Jan Nowak", "Auth.header.register.description": "Aby zakończyć konfigurację i zabezpieczyć swoją aplikację, utwórz pierwszego użytkownika (administratora root), wypełniając poniższe informacje.", "Auth.link.forgot-password": "Nie pamiętasz hasła?", "Auth.link.ready": "Zaczynamy?", - "components.Input.error.password.noMatch": "Hasło nie pasuje" + "app.containers.App.notification.error.init": "Wystąpił błąd podczas wykonywania żądania do API", + "components.Input.error.password.noMatch": "Hasło nie pasuje", + "form.button.done": "Gotowe", + "notification.form.error.fields": "Formularz zawiera błędy" } From 7fd4e2fd4542cb4863b245a4c5d43a2f7e55e0cb Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Wed, 23 Oct 2019 10:11:53 +0200 Subject: [PATCH 02/27] Fix dead link and link path --- docs/3.0.0-beta.x/content-api/parameters.md | 4 ++-- .../getting-started/install-requirements.md | 2 +- .../getting-started/introduction.md | 12 ++++------ .../getting-started/quick-start-tutorial.md | 17 ++++--------- .../getting-started/quick-start.md | 6 ++--- docs/3.0.0-beta.x/guides/databases.md | 12 +++++----- docs/3.0.0-beta.x/guides/deployment.md | 24 +++++++++---------- .../migration-guide-alpha.26-to-beta.md | 4 ++-- .../migration-guide-beta.15-to-beta.16.md | 8 +++---- .../plugin-development/backend-development.md | 8 +++---- .../frontend-development.md | 4 ++-- 11 files changed, 46 insertions(+), 55 deletions(-) diff --git a/docs/3.0.0-beta.x/content-api/parameters.md b/docs/3.0.0-beta.x/content-api/parameters.md index 7c5a6c6ab4..a3855983e4 100644 --- a/docs/3.0.0-beta.x/content-api/parameters.md +++ b/docs/3.0.0-beta.x/content-api/parameters.md @@ -1,9 +1,9 @@ # Parameters -See the [parameters' concepts](../concepts/concepts.md#parameters) for details. +See the [parameters' concepts](../concepts/parameters.md) for details. ::: warning -By default, the filters can only be used from `find` endpoints generated by the Content Type Builder and the [CLI](../cli/CLI.md). If you need to implement a filters system somewhere else, read the [programmatic usage](../guides/parameters.md) section. +By default, the filters can only be used from `find` endpoints generated by the Content Type Builder and the [CLI](../cli/CLI.md). If you need to implement a filters system somewhere else, read the [programmatic usage](../concepts/parameters.md) section. ::: ## Available operators diff --git a/docs/3.0.0-beta.x/getting-started/install-requirements.md b/docs/3.0.0-beta.x/getting-started/install-requirements.md index 73c044d48e..816ca6bfd3 100644 --- a/docs/3.0.0-beta.x/getting-started/install-requirements.md +++ b/docs/3.0.0-beta.x/getting-started/install-requirements.md @@ -130,5 +130,5 @@ npm -v You can also use yarn if you want [here](https://yarnpkg.com/en/docs/getting-started) are the instructions to get started with it. ::: tip NEXT STEPS -👏 Congrats, you are all set! Now that Node.js is installed you can continue with the [Quick start guide](/3.0.0-beta.x/getting-started/quick-start.html). +👏 Congrats, you are all set! Now that Node.js is installed you can continue with the [Quick start guide](quick-start.md). ::: diff --git a/docs/3.0.0-beta.x/getting-started/introduction.md b/docs/3.0.0-beta.x/getting-started/introduction.md index 3e61ef9861..2b71aaade0 100644 --- a/docs/3.0.0-beta.x/getting-started/introduction.md +++ b/docs/3.0.0-beta.x/getting-started/introduction.md @@ -1,4 +1,4 @@ -# Introduction +# Introduction Welcome to the open source [headless CMS](https://strapi.io) developers love. @@ -6,15 +6,13 @@ Welcome to the open source [headless CMS](https://strapi.io) developers love. ### 👋 Welcome onboard! -Users love Strapi because it is open source, MIT licensed, fully customizable and based on Node.js. Strapi lets you manage your content and distribute it anywhere. Strapi allows you to securely and privately serve your database of choice from your hosting and server of choice. +Users love Strapi because it is open source, MIT licensed, fully customizable and based on Node.js. Strapi lets you manage your content and distribute it anywhere. Strapi allows you to securely and privately serve your database of choice from your hosting and server of choice. ### Get Started You are invited to get started using Strapi. You may explore Strapi by: -1. A [Quick Start Guide](../getting-started/quick-start.html) for more intermediate to advanced developers. -2. A [Tutorial](../getting-started/quick-start-tutorial.html) for those who prefer a step-by-step introduction. - -When you're done getting started, we invite you to join our [community](https://strapi.io/community). - +1. A [Quick Start Guide](quick-start.md) for more intermediate to advanced developers. +2. A [Tutorial](quick-start-tutorial.md) for those who prefer a step-by-step introduction. +When you're done getting started, we invite you to join our [community](https://strapi.io/community). diff --git a/docs/3.0.0-beta.x/getting-started/quick-start-tutorial.md b/docs/3.0.0-beta.x/getting-started/quick-start-tutorial.md index e142c61172..6897e85ad6 100644 --- a/docs/3.0.0-beta.x/getting-started/quick-start-tutorial.md +++ b/docs/3.0.0-beta.x/getting-started/quick-start-tutorial.md @@ -1,6 +1,6 @@ # Tutorial -This **tutorial** is written for developers to **teach and explain** a step-by-step introduction to Strapi. (The [Quick Start Guide](/3.0.0-beta.x/getting-started/quick-start.html) is a more concise **How-to** version.) This tutorial takes you through the beginning steps of how you start a project like **"FoodAdvisor"** ([Github](https://github.com/strapi/foodadvisor/))([Demo](https://foodadvisor.strapi.io/)). +This **tutorial** is written for developers to **teach and explain** a step-by-step introduction to Strapi. (The [Quick Start Guide](quick-start.md) is a more concise **How-to** version.) This tutorial takes you through the beginning steps of how you start a project like **"FoodAdvisor"** ([Github](https://github.com/strapi/foodadvisor/))([Demo](https://foodadvisor.strapi.io/)). You get a good overview of the features developers love found in Strapi. @@ -10,20 +10,13 @@ By following this tutorial, you install and create your first Strapi project. ::: tip NOTE -You need to have **_Node.js and npm_** installed on your system before following these steps. If you do not have Node.js and npm installed (or are not sure), please visit our [Installation Requirements](/3.0.0-beta.x/getting-started/install-requirements.html). +You need to have **_Node.js and npm_** installed on your system before following these steps. If you do not have Node.js and npm installed (or are not sure), please visit our [Installation Requirements](install-requirements.md). ::: **Table of Contents** -1. [Install Strapi and create project](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_1-install-strapi-and-create-a-project) -2. [Create an Administrator and front-end User](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_2-create-an-adminstrator-and-front-end-user) -3. [Create a new Content Type called, "Restaurant"](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_3-create-a-new-content-type-called-restaurant) -4. [Create a new Content Type called, "Category"](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_4-create-a-new-content-type-called-category) -5. [Create a new Group and Repeatable Field called, "Hours of Operations"](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_5-create-a-new-group-and-repeatable-field-called-hours-of-operation) -6. [Manage and add content to the "Restaurant" Content Type](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_6-manage-and-add-content-to-a-restaurant-content-type) -7. [Set Roles and Permissions](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_7-set-roles-and-permissions) -8. [Consume the Content Type API](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_8-consume-the-content-type-api) +[[toc]] ## 1. Install Strapi and create a project @@ -140,7 +133,7 @@ Using the `--quickstart` flag installs Strapi using an [SQLite](https://www.sqli **Note:** An **SQLite** database is an excellent database to use for prototyping and _developing_ Strapi projects. **SQLite** is a light database that ports effortlessly to the other relational databases (**MySQL**, **PostgreSQL**, and **MariaDB**). It is recommended to **develop** with SQLite and to use another relational database (MySQL, PostgreSQL or MariaDB) in production. -**Note:** If you would like to use **MongoDB** in production, you need to [install, run, and use MongoDB to develop your Strapi project (in development)](/3.0.0-beta.x/guides/databases.html#mongodb-installation). +**Note:** If you would like to use **MongoDB** in production, you need to [install, run, and use MongoDB to develop your Strapi project (in development)](../guides/databases.md#mongodb-installation). ::: You are now ready to create a new **Administrator** and new front-end **User**. @@ -626,7 +619,7 @@ If you would like to see the route of any specific **Content Type**, you need to 👏 Congratulations, you have now completed the **Strapi Getting Started Tutorial**. Where to go next? - Learn how to use Strapi with React ([Gatsby](https://blog.strapi.io/building-a-static-website-using-gatsby-and-strapi) or [Next.js](https://blog.strapi.io/strapi-next-setup/)) or Vue.js ([Nuxt.js](https://blog.strapi.io/cooking-a-deliveroo-clone-with-nuxt-vue-js-graphql-strapi-and-stripe-setup-part-1-7/)). -- Read the [concepts](../concepts/concepts.html) to deep dive into Strapi +- Read the **concepts** to deep dive into Strapi - Get help on [StackOverflow](https://stackoverflow.com/questions/tagged/strapi) - Read the [source code](https://github.com/strapi/strapi), [contribute](https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md) or [give a star](https://github.com/strapi/strapi) on GitHub - Follow us on [Twitter](https://twitter.com/strapijs) to get the latest news diff --git a/docs/3.0.0-beta.x/getting-started/quick-start.md b/docs/3.0.0-beta.x/getting-started/quick-start.md index 6e17d172db..cabc153edc 100644 --- a/docs/3.0.0-beta.x/getting-started/quick-start.md +++ b/docs/3.0.0-beta.x/getting-started/quick-start.md @@ -6,9 +6,9 @@ Get ready to get Strapi up and running in **less than 5 minutes** 🚀. -_For a step-by-step guide, please take a look at the [detailed tutorial](quick-start-tutorial.html)._ +_For a step-by-step guide, please take a look at the [detailed tutorial](quick-start-tutorial.md)._ -(Before continuing, please make sure [Node.js and npm are properly installed](install-requirements.html) on your machine. You can [install the Yarn v1.2.0+ package here](https://yarnpkg.com/en/).) +(Before continuing, please make sure [Node.js and npm are properly installed](install-requirements.md) on your machine. You can [install the Yarn v1.2.0+ package here](https://yarnpkg.com/en/).) ## 1. Install Strapi and Create a new project @@ -111,7 +111,7 @@ Here we are! The list of **restaurants** is accessible at [`http://localhost:133 👏 Congratulations, you have now completed the **Strapi Quick Start**. Where to go next? - Learn how to use Strapi with React ([Gatsby](https://blog.strapi.io/building-a-static-website-using-gatsby-and-strapi) or [Next.js](https://blog.strapi.io/strapi-next-setup/)) or Vue.js ([Nuxt.js](https://blog.strapi.io/cooking-a-deliveroo-clone-with-nuxt-vue-js-graphql-strapi-and-stripe-setup-part-1-7/)). -- Read the [concepts](../concepts/concepts.html) and do the [Tutorial](/3.0.0-beta.x/getting-started/quick-start-tutorial.html) to deep dive into Strapi. +- Read the **concepts** and do the [Tutorial](quick-start-tutorial.md) to deep dive into Strapi. - Get help on [StackOverflow](https://stackoverflow.com/questions/tagged/strapi). - Read the [source code](https://github.com/strapi/strapi), [contribute](https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md) or [give a star](https://github.com/strapi/strapi) on GitHub. - Follow us on [Twitter](https://twitter.com/strapijs) to get the latest news. diff --git a/docs/3.0.0-beta.x/guides/databases.md b/docs/3.0.0-beta.x/guides/databases.md index 11259bc574..8d820427bd 100644 --- a/docs/3.0.0-beta.x/guides/databases.md +++ b/docs/3.0.0-beta.x/guides/databases.md @@ -4,12 +4,12 @@ Strapi gives you the option to choose the most appropriate database for your pro **MariaDB**. The following documentation covers how to install these databases locally (for development purposes) and on various hosted or cloud server solutions (for staging or production purposes). :::note -Deploying **Strapi** itself is covered in the [Deployment Guide](/3.0.0-beta.x/guides/deployment.html). +Deploying **Strapi** itself is covered in the [Deployment Guide](deployment.md). ::: ## SQLite Installation -SQLite is the default ([Quick Start](/3.0.0-beta.x/getting-started/quick-start.html)) and recommended database to quickly create an app locally. +SQLite is the default ([Quick Start](../getting-started/quick-start.md)) and recommended database to quickly create an app locally. ### Install SQLite locally @@ -38,7 +38,7 @@ npx create-strapi-app my-project --quickstart This will create a new project and launch it in the browser. ::: note -The [Quick Start Guide](/3.0.0-beta.x/getting-started/quick-start.html) is a complete step-by-step tutorial +The [Quick Start Guide](../getting-started/quick-start.md) is a complete step-by-step tutorial ::: ## MongoDB Installation @@ -240,7 +240,7 @@ $ strapi develop ``` -You have successfully installed Strapi with MongoDB on your local development environment. You are now ready to [create your first user](/3.0.0-beta.x/getting-started/quick-start.html#_3-create-an-admin-user). +You have successfully installed Strapi with MongoDB on your local development environment. You are now ready to [create your first user](../getting-started/quick-start.md#_3-create-an-admin-user). --- @@ -248,7 +248,7 @@ You have successfully installed Strapi with MongoDB on your local development en Follow these steps to configure a local Strapi project to use a [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) free 512 MB account in production. (Please see [MongoDB Atlas Documentation](https://docs.atlas.mongodb.com/getting-started/) if you have any questions.) -- You must have already [created your Strapi project using MongoDB](/3.0.0-beta.x/guides/databases.html#install-strapi-locally-with-mongodb). +- You must have already [created your Strapi project using MongoDB](databases.md#install-strapi-locally-with-mongodb). - You must have already created a [free MongoDB Atlas account](https://www.mongodb.com/cloud/atlas). #### 1. Log in to your account to create a **Project** and a **Cluster** @@ -342,7 +342,7 @@ The above configuration will create a database called `strapi`, the _default dat ::: ::: danger WARNING -We recommend replacing sensitive (eg. "URI string" above) information in your database.json files before uploading your project to a public repository such as GitHub. For more information about using environment variables, please read [dynamic configurations](/3.0.0-beta.x/configurations/configurations.html#dynamic-configurations). +We recommend replacing sensitive (eg. "URI string" above) information in your database.json files before uploading your project to a public repository such as GitHub. For more information about using environment variables, please read [dynamic configurations](../concepts/configurations.md#dynamic-configurations). ::: diff --git a/docs/3.0.0-beta.x/guides/deployment.md b/docs/3.0.0-beta.x/guides/deployment.md index 96519b228c..5bc1fc9d51 100644 --- a/docs/3.0.0-beta.x/guides/deployment.md +++ b/docs/3.0.0-beta.x/guides/deployment.md @@ -3,7 +3,7 @@ Strapi gives you many possible deployment options for your project or application. Strapi can be deployed on traditional hosting servers or services such as Heroku, AWS, Azure and others. The following documentation covers how to develop locally with Strapi and deploy Strapi with various hosting options. ::: note -Deploying **databases** along with Strapi is covered in the [Databases Guide](/3.0.0-beta.x/guides/databases.html). +Deploying **databases** along with Strapi is covered in the [Databases Guide](../guides/databases.md). ::: ## Configuration @@ -24,7 +24,7 @@ Update the `production` settings with the IP and domain name where the project w In case your database is not running on the same server, make sure that the environment of your production database (`./config/environments/production/database.json`) is set properly. -If you are passing a number of configuration item values via environment variables which is always encouraged for production environment, read the section for [Dynamic Configuration](../configurations/configurations.md#dynamic-configurations). Here is an example: +If you are passing a number of configuration item values via environment variables which is always encouraged for production environment, read the section for [Dynamic Configuration](../concepts/configurations.md#dynamic-configurations). Here is an example: **Path —** `./config/environments/production/server.json`. @@ -95,11 +95,11 @@ strapi(/* {...} */).start(); ### Advanced configurations -If you want to host the administration on another server than the API, [please take a look at this dedicated section](../advanced/customize-admin.md#deployment). +If you want to host the administration on another server than the API, [please take a look at this dedicated section](../admin-panel/deploy.md). ## Amazon AWS -This is a step-by-step guide for deploying a Strapi project to [Amazon AWS EC2](https://aws.amazon.com/ec2/). This guide will connect to an [Amazon AWS RDS](https://aws.amazon.com/rds/) for managing and hosting the database. Optionally, this guide will show you how to connect host and serve images on [Amazon AWS S3](https://aws.amazon.com/s3/). Prior to starting this guide, you should have created a [Strapi project](/3.0.0-beta.x/getting-started/quick-start.html), to use for deploying on AWS. +This is a step-by-step guide for deploying a Strapi project to [Amazon AWS EC2](https://aws.amazon.com/ec2/). This guide will connect to an [Amazon AWS RDS](https://aws.amazon.com/rds/) for managing and hosting the database. Optionally, this guide will show you how to connect host and serve images on [Amazon AWS S3](https://aws.amazon.com/s3/). Prior to starting this guide, you should have created a [Strapi project](../getting-started/quick-start.md), to use for deploying on AWS. ### Amazon AWS Install Requirement and creating an IAM non-root user @@ -748,7 +748,7 @@ Your `Strapi` project has been installed on an **AWS EC2 instance** using **Ubun ## Digital Ocean -This is a step-by-step guide for deploying a Strapi project to [Digital Ocean](https://www.digitalocean.com/). Databases can be on a [Digital Ocean Droplet](https://www.digitalocean.com/docs/droplets/) or hosted externally as a service. Prior to starting this guide, you should have created a [Strapi project](/3.0.0-beta.x/getting-started/quick-start.html). +This is a step-by-step guide for deploying a Strapi project to [Digital Ocean](https://www.digitalocean.com/). Databases can be on a [Digital Ocean Droplet](https://www.digitalocean.com/docs/droplets/) or hosted externally as a service. Prior to starting this guide, you should have created a [Strapi project](../getting-started/quick-start.md). ### Digital Ocean Install Requirements @@ -979,7 +979,7 @@ Command may disrupt existing ssh connections. Proceed with operation (y|n)? y Firewall is active and enabled on system startup ``` -Your Strapi project is now installed on your **Droplet**. You have a few more steps prior to being able to access Strapi and [create your first user](https://strapi.io/documentation/3.0.0-beta.x/getting-started/quick-start.html#_3-create-an-admin-user). +Your Strapi project is now installed on your **Droplet**. You have a few more steps prior to being able to access Strapi and [create your first user](../getting-started/quick-start.md#_3-create-an-admin-user). You will next need to [install and configure PM2 Runtime](#install-and-configure-pm2-runtime). @@ -1037,7 +1037,7 @@ pm2 start ecosystem.config.js `pm2` is now set-up to use an `ecosystem.config.js` to manage restarting your application upon changes. This is a recommended best practice. -**OPTIONAL:** You may see your project and set-up your first administrator user, by [creating an admin user](https://strapi.io/documentation/3.0.0-beta.x/getting-started/quick-start.html#_3-create-an-admin-user). +**OPTIONAL:** You may see your project and set-up your first administrator user, by [creating an admin user](../getting-started/quick-start.md#_3-create-an-admin-user). ::: note Earlier, `Port 1337` was allowed access for **testing and setup** purposes. After setting up **NGINX**, the **Port 1337** needs to have access **denied**. @@ -1298,11 +1298,11 @@ Follow the instructions and return to your command line. #### 3. Create a new project (or use an existing one) -Create a [new Strapi project](/3.0.0-beta.x/getting-started/quick-start.html) (if you want to deploy an existing project go to step 4). +Create a [new Strapi project](../getting-started/quick-start.md) (if you want to deploy an existing project go to step 4). ::: warning NOTE -If you plan to use **MongoDB** with your project, [refer to the create a Strapi project with MongoDB section of the documentation](/3.0.0-beta.x/guides/databases.html#install-mongodb-locally) then, jump to step 4. +If you plan to use **MongoDB** with your project, [refer to the create a Strapi project with MongoDB section of the documentation](../guides/databases.md#install-mongodb-locally) then, jump to step 4. ::: @@ -1463,11 +1463,11 @@ npm install pg --save Please follow these steps the **deploy a Strapi app with MongoDB on Heroku**. -You must have completed the [steps to use Strapi with MongoDB Atlas](/3.0.0-beta.x/guides/databases.html#install-on-atlas-mongodb-atlas) - through **4. Retrieve database credentials**. +You must have completed the [steps to use Strapi with MongoDB Atlas](../guides/databases.md#install-on-atlas-mongodb-atlas) - through **4. Retrieve database credentials**. #### 1. Set environment variables -When you [set-up your MongoDB Atlas database](/3.0.0-beta.x/guides/databases.html#install-on-atlas-mongodb-atlas) you noted a connection string. Similar to this: +When you [set-up your MongoDB Atlas database](../guides/databases.md#install-on-atlas-mongodb-atlas) you noted a connection string. Similar to this: ```bash mongodb://paulbocuse:@strapidatabase-shard-00-00-fxxx6c.mongodb.net:27017,strapidatabase-shard-00-01-fxxxc.mongodb.net:27017,strapidatabase-shard-00-02-fxxxc.mongodb.net:27017/test?ssl=true&replicaSet=strapidatabase-shard-0&authSource=admin&retryWrites=true&w=majority @@ -1538,7 +1538,7 @@ heroku open If you see the Strapi Welcome page, you have correctly set-up, configured and deployed your Strapi project on Heroku. You will now need to set-up your `admin user` as the production database is brand-new (and empty). -You can now continue with the [Tutorial - Creating an Admin User](/3.0.0-beta.x/getting-started/quick-start-tutorial.html#_3-create-an-admin-user), if you have any questions on how to proceed. +You can now continue with the [Tutorial - Creating an Admin User](../getting-started/quick-start-tutorial.md#_3-create-an-admin-user), if you have any questions on how to proceed. ::: warning For security reasons, the Content Type Builder plugin is disabled in production. To update content structure, please make your changes locally and deploy again. diff --git a/docs/3.0.0-beta.x/migration-guide/migration-guide-alpha.26-to-beta.md b/docs/3.0.0-beta.x/migration-guide/migration-guide-alpha.26-to-beta.md index ec1e145b47..e03535b450 100644 --- a/docs/3.0.0-beta.x/migration-guide/migration-guide-alpha.26-to-beta.md +++ b/docs/3.0.0-beta.x/migration-guide/migration-guide-alpha.26-to-beta.md @@ -196,7 +196,7 @@ You can leave all your files in `./config` unchanged but remove the `server.auto One of our main objectives for the `beta` is to make it easier and quicker to upgrade to more recent versions of Strapi. This is why moving forward, plugins will be located in the `node_modules` folder. -[Read more](https://strapi.io/documentation/3.0.0-beta.x/concepts/concepts.html#files-structure) +[Read more](../concepts/file-structure.md) Let's start by creating a new folder called `./extensions`. This folder needs to exist even if it's empty. You may use a `.gitkeep` file to ensure the folder isn't deleted from the repository (if it's empty) when cloning. [More details](https://davidwalsh.name/git-empty-directory). @@ -495,7 +495,7 @@ The only difference is that the admin of a local plugin is ignored for the momen In the `beta`, we are introducing the `Core API`, which is replacing the templates that were generated before. Now when you create a new model your `controller` and `service` will be empty modules and will be used to override the default behaviors. -Read more about [controllers](https://strapi.io/documentation/3.0.0-beta.x/guides/controllers.html) or [services](https://strapi.io/documentation/3.0.0-beta.x/guides/services.html) +Read more about [controllers](../concepts/controllers.md) or [services](../concepts/services.md) To migrate, you will only have to delete the methods you haven't modified or created from your `controllers` and `services` diff --git a/docs/3.0.0-beta.x/migration-guide/migration-guide-beta.15-to-beta.16.md b/docs/3.0.0-beta.x/migration-guide/migration-guide-beta.15-to-beta.16.md index bc34092dee..4d164b7512 100644 --- a/docs/3.0.0-beta.x/migration-guide/migration-guide-beta.15-to-beta.16.md +++ b/docs/3.0.0-beta.x/migration-guide/migration-guide-beta.15-to-beta.16.md @@ -90,7 +90,7 @@ To make sure a Wysiwyg field stays the same when deploying, we introduced the `r ### Custom controllers and services -If you are using [core services](../guides/services.md), you previously needed to call `result.toJSON()` or `result.toObject()` to get a plain javascript object. This is not the case anymore, you will now receive a simple object directly. +If you are using [core services](../concepts/services.md), you previously needed to call `result.toJSON()` or `result.toObject()` to get a plain javascript object. This is not the case anymore, you will now receive a simple object directly. **Before**: @@ -113,9 +113,9 @@ module.exports = { }; ``` -The same modification was made to `strapi.query()`. Read more about **Queries** [here](../guides/queries.md). +The same modification was made to `strapi.query()`. Read more about **Queries** [here](../concepts/queries.md). -Keep in mind that if you are running custom ORM queries with Bookshelf or Mongoose you will still have to call `toJSON` or `toObject`. Check out this section about [custom queries](../guides/queries.html#api-reference). +Keep in mind that if you are running custom ORM queries with Bookshelf or Mongoose you will still have to call `toJSON` or `toObject`. Check out this section about [custom queries](../concepts/queries.md#api-reference). ### Bootstrap function @@ -167,7 +167,7 @@ module.exports = () => {}; ### Custom hooks -If you have custom [hooks](../advanced/hooks.md) in your project, the `initialize` function will not receive a callback anymore. You can either use an async function, return a promise or simply run a synchronous function. +If you have custom [hooks](../concepts/hooks.md) in your project, the `initialize` function will not receive a callback anymore. You can either use an async function, return a promise or simply run a synchronous function. **Before** diff --git a/docs/3.0.0-beta.x/plugin-development/backend-development.md b/docs/3.0.0-beta.x/plugin-development/backend-development.md index 8a27a4662c..58162a2f9e 100644 --- a/docs/3.0.0-beta.x/plugin-development/backend-development.md +++ b/docs/3.0.0-beta.x/plugin-development/backend-development.md @@ -7,7 +7,7 @@ This section explains how the 'back-end part' of your plugin works. The plugin API routes are defined in the `./plugins/**/config/routes.json` file. ::: note -Please refer to [router documentation](../guides/routing.md) for information. +Please refer to [router documentation](../concepts/routing.md) for information. ::: **Route prefix** @@ -38,7 +38,7 @@ Please refer to the [CLI documentation](../cli/CLI.md) for more information. Controllers contain functions executed according to the requested route. -Please refer to the [Controllers documentation](../guides/controllers.md) for more information. +Please refer to the [Controllers documentation](../concepts/controllers.md) for more information. ## Models @@ -61,7 +61,7 @@ module.exports = { Also, the table/collection name won't be `users` because you already have a `User` model. That's why, the framework will automatically prefix the table/collection name for this model with the name of the plugin. Which means in our example, the table/collection name of the `User` model of our plugin `Users & Permissions` will be `users-permissions_users`. If you want to force the table/collection name of the plugin's model, you can add the `collectionName` attribute in your model. -Please refer to the [Models documentation](../guides/models.md) for more information. +Please refer to the [Models documentation](../concepts/models.md) for more information. ## Policies @@ -103,7 +103,7 @@ A plugin can have its own policies, such as adding security rules. For instance, } ``` -Please refer to the [Policies documentation](../guides/policies.md) for more information. +Please refer to the [Policies documentation](../concepts/policies.md) for more information. ## ORM queries diff --git a/docs/3.0.0-beta.x/plugin-development/frontend-development.md b/docs/3.0.0-beta.x/plugin-development/frontend-development.md index 076c7b9245..fcaa9daace 100644 --- a/docs/3.0.0-beta.x/plugin-development/frontend-development.md +++ b/docs/3.0.0-beta.x/plugin-development/frontend-development.md @@ -4,7 +4,7 @@ This feature is currently not available (coming soon). ::: - From db8fa6fd5d062618d41046ff510b977494b98972 Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Wed, 23 Oct 2019 10:51:51 +0200 Subject: [PATCH 03/27] Create custom local providers --- docs/3.0.0-beta.x/plugins/email.md | 23 +++++++++++++++++++++++ docs/3.0.0-beta.x/plugins/upload.md | 23 +++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/docs/3.0.0-beta.x/plugins/email.md b/docs/3.0.0-beta.x/plugins/email.md index 97fc777238..cc7d83ce96 100644 --- a/docs/3.0.0-beta.x/plugins/email.md +++ b/docs/3.0.0-beta.x/plugins/email.md @@ -88,3 +88,26 @@ In the `send` function you will have access to: - `config` that contain configuration you setup in your admin panel - `options` that contain option your send when you called the `send` function from the email plugin service + +To use it you will have to publish it on **npm**. + +### Create a local provider + +If you want create your own provider without publishing it on **npm** you can follow these following steps: + +- You create a `providers` folder in your application. +- Create your provider as explain in the documentation eg. `./providers/strapi-provider-email-[...]/...` +- Then update your `package.json` to link your `strapi-provider-email-[...]` dependency to the [local path](https://docs.npmjs.com/files/package.json#local-paths) of your new provider. + +```json +{ + ... + "dependencies": { + ... + "strapi-provider-email-[...]": "file:providers/strapi-provider-email-[...]", + ... + } +} +``` + +- Finally, run `yarn install` or `npm install` to install your new custom provider. diff --git a/docs/3.0.0-beta.x/plugins/upload.md b/docs/3.0.0-beta.x/plugins/upload.md index 4bcbc54741..caddb40764 100644 --- a/docs/3.0.0-beta.x/plugins/upload.md +++ b/docs/3.0.0-beta.x/plugins/upload.md @@ -293,3 +293,26 @@ Then, visit [http://localhost:1337/admin/plugins/upload/configurations/developme ## Create providers If you want to create your own, make sure the name starts with `strapi-provider-upload-` (duplicating an existing one will be easier to create), modify the `auth` config object and customize the `upload` and `delete` functions. + +To use it you will have to publish it on **npm**. + +### Create a local provider + +If you want create your own provider without publishing it on **npm** you can follow these following steps: + +- You create a `providers` folder in your application. +- Create your provider as explain in the documentation eg. `./providers/strapi-provider-upload-[...]/...` +- Then update your `package.json` to link your `strapi-provider-upload-[...]` dependency to the [local path](https://docs.npmjs.com/files/package.json#local-paths) of your new provider. + +```json +{ + ... + "dependencies": { + ... + "strapi-provider-upload-[...]": "file:providers/strapi-provider-upload-[...]", + ... + } +} +``` + +- Finally, run `yarn install` or `npm install` to install your new custom provider. From 87a2c35434631a8ec882498ed148689b07b8d123 Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Wed, 23 Oct 2019 11:19:38 +0200 Subject: [PATCH 04/27] Update service call from controller --- docs/3.0.0-beta.x/concepts/controllers.md | 35 ++++++++++++++++------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/docs/3.0.0-beta.x/concepts/controllers.md b/docs/3.0.0-beta.x/concepts/controllers.md index 25f72f0acb..b31a37552e 100644 --- a/docs/3.0.0-beta.x/concepts/controllers.md +++ b/docs/3.0.0-beta.x/concepts/controllers.md @@ -50,6 +50,8 @@ const { parseMultipartData, sanitizeEntity } = require('strapi-utils'); #### `find` ```js +const { sanitizeEntity } = require('strapi-utils'); + module.exports = { /** * Retrieve records. @@ -60,9 +62,9 @@ module.exports = { async find(ctx) { let entities; if (ctx.query._q) { - entities = await service.search(ctx.query); + entities = await strapi.services.restaurant.search(ctx.query); } else { - entities = await service.find(ctx.query); + entities = await strapi.services.restaurant.find(ctx.query); } return entities.map(entity => sanitizeEntity(entity, { model })); @@ -77,6 +79,8 @@ module.exports = { #### `findOne` ```js +const { sanitizeEntity } = require('strapi-utils'); + module.exports = { /** * Retrieve a record. @@ -85,7 +89,7 @@ module.exports = { */ async findOne(ctx) { - const entity = await service.findOne(ctx.params); + const entity = await strapi.services.restaurant.findOne(ctx.params); return sanitizeEntity(entity, { model }); }, }; @@ -107,9 +111,9 @@ module.exports = { count(ctx) { if (ctx.query._q) { - return service.countSearch(ctx.query); + return strapi.services.restaurant.countSearch(ctx.query); } - return service.count(ctx.query); + return strapi.services.restaurant.count(ctx.query); }, }; ``` @@ -121,6 +125,8 @@ module.exports = { #### `create` ```js +const { parseMultipartData, sanitizeEntity } = require('strapi-utils'); + module.exports = { /** * Create a record. @@ -132,9 +138,9 @@ module.exports = { let entity; if (ctx.is('multipart')) { const { data, files } = parseMultipartData(ctx); - entity = await service.create(data, { files }); + entity = await strapi.services.restaurant.create(data, { files }); } else { - entity = await service.create(ctx.request.body); + entity = await strapi.services.restaurant.create(ctx.request.body); } return sanitizeEntity(entity, { model }); }, @@ -148,6 +154,8 @@ module.exports = { #### `update` ```js +const { parseMultipartData, sanitizeEntity } = require('strapi-utils'); + module.exports = { /** * Update a record. @@ -159,9 +167,14 @@ module.exports = { let entity; if (ctx.is('multipart')) { const { data, files } = parseMultipartData(ctx); - entity = await service.update(ctx.params, data, { files }); + entity = await strapi.services.restaurant.update(ctx.params, data, { + files, + }); } else { - entity = await service.update(ctx.params, ctx.request.body); + entity = await strapi.services.restaurant.update( + ctx.params, + ctx.request.body + ); } return sanitizeEntity(entity, { model }); @@ -176,6 +189,8 @@ module.exports = { #### `delete` ```js +const { sanitizeEntity } = require('strapi-utils'); + module.exports = { /** * delete a record. @@ -184,7 +199,7 @@ module.exports = { */ async delete(ctx) { - const entity = await service.delete(ctx.params); + const entity = await strapi.services.restaurant.delete(ctx.params); return sanitizeEntity(entity, { model }); }, }; From ccfff990ff27a0d159fe00f1a088199bc3cc515e Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Wed, 23 Oct 2019 14:36:51 +0200 Subject: [PATCH 05/27] Add error handling guide --- docs/.vuepress/config.js | 1 + docs/3.0.0-beta.x/guides/error-handling.md | 89 ++++++++++++++++++++++ 2 files changed, 90 insertions(+) create mode 100644 docs/3.0.0-beta.x/guides/error-handling.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 03fb10ae3d..319a2ec0fb 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -126,6 +126,7 @@ module.exports = { children: [ '/3.0.0-beta.x/guides/databases', '/3.0.0-beta.x/guides/deployment', + '/3.0.0-beta.x/guides/error-handling', '/3.0.0-beta.x/guides/webhooks', ], }, diff --git a/docs/3.0.0-beta.x/guides/error-handling.md b/docs/3.0.0-beta.x/guides/error-handling.md new file mode 100644 index 0000000000..6c9b899fc5 --- /dev/null +++ b/docs/3.0.0-beta.x/guides/error-handling.md @@ -0,0 +1,89 @@ +# Error handling + +In this guide we will see how you can handle errors to send it on the Application Monitoring / Error Tracking Software you want. + +::: note +In this example we will use [Sentry](https://sentry.io). +::: + +## Create a middleware + +To handle errors, we will have to use a [middleware](../concepts/middlewares.md) that will catch errors and send them to Sentry. + +- Create a `./middlewares/sentry/index.js` file. + +**Path —** `./middlewares/sentry/index.js` + +```js +module.exports = strapi => { + return { + initialize() { + strapi.app.use(async (ctx, next) => { + await next(); + }); + }, + }; +}; +``` + +## Handle errors + +Here is the [Node.js client documentation](https://docs.sentry.io/clients/node/) + +- Now add the logic that will catch errors. + +**Path —** `./middlewares/sentry/index.js` + +```js +var Raven = require('raven'); +Raven.config('https://@sentry.io/').install(); + +module.exports = strapi => { + return { + initialize() { + strapi.app.use(async (ctx, next) => { + try { + await next(); + } catch (error) { + Raven.captureException(error); + throw error; + } + }); + }, + }; +}; +``` + +::: warning +It's important to `throw(error);` to not stop the middleware stack. If you don't do that, **Boom** will not structure errors messages. +::: + +## Configure the middleware + +You will have to order this middleware at the end of the middleware stack. + +**Path —** `./config/middleware.json` + +```json +{ + ... + "after": [ + "parser", + "router", + "sentry" + ] + } +} +``` + +And fianlly you have to enable the middleware. + +**Path —** `./config/environments/**/middleware.json` + +```json +{ + "sentry": { + "enabled": true + } +} +``` From 7e09cc066180f2b05b82b0a2f6f6323450a1ddc4 Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Wed, 23 Oct 2019 17:56:17 +0200 Subject: [PATCH 06/27] Add jwt validation guide --- docs/.vuepress/config.js | 1 + docs/3.0.0-beta.x/guides/jwt-validation.md | 103 +++++++++++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 docs/3.0.0-beta.x/guides/jwt-validation.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 319a2ec0fb..94034e9886 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -126,6 +126,7 @@ module.exports = { children: [ '/3.0.0-beta.x/guides/databases', '/3.0.0-beta.x/guides/deployment', + '/3.0.0-beta.x/guides/jwt-validation', '/3.0.0-beta.x/guides/error-handling', '/3.0.0-beta.x/guides/webhooks', ], diff --git a/docs/3.0.0-beta.x/guides/jwt-validation.md b/docs/3.0.0-beta.x/guides/jwt-validation.md new file mode 100644 index 0000000000..73ec509333 --- /dev/null +++ b/docs/3.0.0-beta.x/guides/jwt-validation.md @@ -0,0 +1,103 @@ +# JWT validation + +In this guide we will see how validate a JWT via another service. + +When you signin with the authentication route `POST /auth/local`, Strapi generate a `JWT` that let your users request your API as an authenticated user. + +```json +{ + "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiaXNBZG1pbiI6dHJ1ZSwiaWF0IjoxNTcxODIyMDAzLCJleHAiOjE1NzQ0MTQwMDN9.T5XQGSDZ6TjgM5NYaVDbYJt84qHZTrtBqWu1Q3ShINw", + "user": { + "email": "admin@strapi.io", + "id": 1, + "username": "admin" + } +} +``` + +These users are managed in the application database and can be managed via the admin dashboard. + +We can now imagine you have a `JWT` that come from [Auth0](https://auth0.com) and you want to make sure the `JWT` is correct and allow this user to use the Strapi API endpoints. + +## Customise the JWT validation function + +We have to use the [customization concept](../concepts/customization.md) to update the function that validate the `JWT`. This feature is powered by the **Users & Permissions** plugin. + +Here is the file we will have to customize: [permission.js](https://github.com/strapi/strapi/blob/master/packages/strapi-plugin-users-permissions/config/policies/permissions.js) + +- We have now to create a file that follow this path `./extensions/users-permissions/config/policies/permissions.js`. +- You will have to add in this new file, the same content of the original one. + +Now we are ready to create our custom validation code. + +## Write our own logic + +First we have to define where write our code. + +```js +const _ = require('lodash'); + +module.exports = async (ctx, next) => { + let role; + + if (ctx.request && ctx.request.header && ctx.request.header.authorization) { + try { + const { id, isAdmin = false } = await strapi.plugins[ + 'users-permissions' + ].services.jwt.getToken(ctx); + + ... + + } catch (err) { + // It will be there! + + return handleErrors(ctx, err, 'unauthorized'); + } +``` + +The `jwt.getToken` will throw and error it the token don't come from Strapi. So if it's not a Strapi `JWT` token, lets test if it's an Auth0 token. + +We will have to write our validation code before throwing an error. + +By using the [Auth0 get user profile](https://auth0.com/docs/api/authentication?http#get-user-info) documentation, I will verify a valid user match with the current `JWT` + +```js +const _ = require('lodash'); +const axios = require('axios'); + +module.exports = async (ctx, next) => { + let role; + + if (ctx.request && ctx.request.header && ctx.request.header.authorization) { + try { + const { id, isAdmin = false } = await strapi.plugins[ + 'users-permissions' + ].services.jwt.getToken(ctx); + + ... + + } catch (err) { + try { + const data = await axios({ + method: 'post', + url: 'http://YOUR_DOMAIN/userinfo', + headers: { + Authorization: ctx.request.header.authorization + } + }); + + // if you want do more validation test + // feel free to add your code here. + + return await next(); + } catch (error) { + return handleErrors(ctx, new Error('Invalid token: Token did not match with Strapi and Auth0'), 'unauthorized'); + } + + return handleErrors(ctx, err, 'unauthorized'); + } +``` + +::: warning +In the code example we use `axios` you will have to install the dependence to make it works or use and other library to request Auth0 API. +::: From 8cfc6e43c6b153709cd4f1e95c109486aa518762 Mon Sep 17 00:00:00 2001 From: Alexandre Bodin Date: Thu, 24 Oct 2019 00:12:20 +0200 Subject: [PATCH 07/27] Fix graphql nested groups returning null --- packages/strapi-hook-bookshelf/lib/mount-models.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/strapi-hook-bookshelf/lib/mount-models.js b/packages/strapi-hook-bookshelf/lib/mount-models.js index c966ef2736..57c96a6b09 100644 --- a/packages/strapi-hook-bookshelf/lib/mount-models.js +++ b/packages/strapi-hook-bookshelf/lib/mount-models.js @@ -740,6 +740,8 @@ module.exports = ({ models, target, plugin = false }, ctx) => { options.withRelated = [] .concat(createGroupsPopulate()) .concat(createAssociationPopulate()); + } else if (_.isEmpty(options.withRelated)) { + options.withRelated = createGroupsPopulate(); } else { options.withRelated = formatPopulateOptions(options.withRelated); } From ae813243183fdc1bb84ab4b9223c9ab4bc8c29a9 Mon Sep 17 00:00:00 2001 From: Derrick Mehaffy Date: Thu, 24 Oct 2019 05:44:58 -0700 Subject: [PATCH 08/27] Add note about uploads for Heroku to deployment docs --- docs/3.0.0-beta.x/guides/deployment.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/3.0.0-beta.x/guides/deployment.md b/docs/3.0.0-beta.x/guides/deployment.md index 5bc1fc9d51..d74cdc201a 100644 --- a/docs/3.0.0-beta.x/guides/deployment.md +++ b/docs/3.0.0-beta.x/guides/deployment.md @@ -1562,3 +1562,11 @@ git commit -am "Changes to my-project noted" git push heroku master heroku open ``` + +--- + +### File Uploads + +Like with project updates on Heroku, the file system doesn't support local uploading of files as they will be wiped when Heroku "Cycles" the dyno. This type of file system is called [ephemeral](https://devcenter.heroku.com/articles/dynos#ephemeral-filesystem), which means the file system only lasts until the dyno is restarted (with Heroku this happens any time you redeploy or during their regular restart which can happen every few hours or every day). + +Due to Heroku's filesystem you will need to use an upload provider such as AWS S3, Cloudinary, or Rackspace. You can view the documentation for installing providers [here](../plugins/upload.md#install-providers) and you can see a list of providers from both Strapi and the community on [npmjs.com](https://www.npmjs.com/search?q=strapi-provider-upload-&page=0&perPage=20). From 3b0c77b5cc066592d9eb33df744f8db25c7d69fa Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Thu, 24 Oct 2019 15:08:42 +0200 Subject: [PATCH 09/27] Fix typo PR feedback --- docs/.vuepress/config.js | 2 +- docs/3.0.0-beta.x/content-api/parameters.md | 2 +- .../getting-started/introduction.md | 2 +- .../{error-handling.md => error-catching.md} | 20 +++++++++---------- docs/3.0.0-beta.x/guides/jwt-validation.md | 20 +++++++++---------- docs/3.0.0-beta.x/plugins/email.md | 6 +++--- docs/3.0.0-beta.x/plugins/upload.md | 6 +++--- 7 files changed, 29 insertions(+), 29 deletions(-) rename docs/3.0.0-beta.x/guides/{error-handling.md => error-catching.md} (58%) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 94034e9886..4c97873780 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -127,7 +127,7 @@ module.exports = { '/3.0.0-beta.x/guides/databases', '/3.0.0-beta.x/guides/deployment', '/3.0.0-beta.x/guides/jwt-validation', - '/3.0.0-beta.x/guides/error-handling', + '/3.0.0-beta.x/guides/error-catching', '/3.0.0-beta.x/guides/webhooks', ], }, diff --git a/docs/3.0.0-beta.x/content-api/parameters.md b/docs/3.0.0-beta.x/content-api/parameters.md index a3855983e4..4862006e71 100644 --- a/docs/3.0.0-beta.x/content-api/parameters.md +++ b/docs/3.0.0-beta.x/content-api/parameters.md @@ -3,7 +3,7 @@ See the [parameters' concepts](../concepts/parameters.md) for details. ::: warning -By default, the filters can only be used from `find` endpoints generated by the Content Type Builder and the [CLI](../cli/CLI.md). If you need to implement a filters system somewhere else, read the [programmatic usage](../concepts/parameters.md) section. +By default, the filters can only be used from `find` endpoints generated by the Content Type Builder and the [CLI](../cli/CLI.md). If you need to implement a filter system somewhere else, read the [programmatic usage](../concepts/parameters.md) section. ::: ## Available operators diff --git a/docs/3.0.0-beta.x/getting-started/introduction.md b/docs/3.0.0-beta.x/getting-started/introduction.md index 2b71aaade0..d66f990c1e 100644 --- a/docs/3.0.0-beta.x/getting-started/introduction.md +++ b/docs/3.0.0-beta.x/getting-started/introduction.md @@ -6,7 +6,7 @@ Welcome to the open source [headless CMS](https://strapi.io) developers love. ### 👋 Welcome onboard! -Users love Strapi because it is open source, MIT licensed, fully customizable and based on Node.js. Strapi lets you manage your content and distribute it anywhere. Strapi allows you to securely and privately serve your database of choice from your hosting and server of choice. +Users love Strapi because it is open source, MIT licensed, fully customizable and based on Node.js. Strapi lets you manage your content and distribute it anywhere. Strapi allows you to securely and privately serve your database from your hosting and server of choice. ### Get Started diff --git a/docs/3.0.0-beta.x/guides/error-handling.md b/docs/3.0.0-beta.x/guides/error-catching.md similarity index 58% rename from docs/3.0.0-beta.x/guides/error-handling.md rename to docs/3.0.0-beta.x/guides/error-catching.md index 6c9b899fc5..077c9a953a 100644 --- a/docs/3.0.0-beta.x/guides/error-handling.md +++ b/docs/3.0.0-beta.x/guides/error-catching.md @@ -1,6 +1,6 @@ -# Error handling +# Error catching -In this guide we will see how you can handle errors to send it on the Application Monitoring / Error Tracking Software you want. +In this guide we will see how you can catch errors and send them to the Application Monitoring / Error Tracking Software you want. ::: note In this example we will use [Sentry](https://sentry.io). @@ -8,7 +8,7 @@ In this example we will use [Sentry](https://sentry.io). ## Create a middleware -To handle errors, we will have to use a [middleware](../concepts/middlewares.md) that will catch errors and send them to Sentry. +A [middleware](../concepts/middlewares.md) will be used in order to catch the errors which will then be sent to Sentry. - Create a `./middlewares/sentry/index.js` file. @@ -28,15 +28,15 @@ module.exports = strapi => { ## Handle errors -Here is the [Node.js client documentation](https://docs.sentry.io/clients/node/) +Here is the [Node.js client documentation](https://docs.sentry.io/platforms/node/) - Now add the logic that will catch errors. **Path —** `./middlewares/sentry/index.js` ```js -var Raven = require('raven'); -Raven.config('https://@sentry.io/').install(); +const Sentry = require('@sentry/node'); +Sentry.init({ dsn: 'https://@sentry.io/' }); module.exports = strapi => { return { @@ -45,7 +45,7 @@ module.exports = strapi => { try { await next(); } catch (error) { - Raven.captureException(error); + Sentry.captureException(error); throw error; } }); @@ -55,12 +55,12 @@ module.exports = strapi => { ``` ::: warning -It's important to `throw(error);` to not stop the middleware stack. If you don't do that, **Boom** will not structure errors messages. +It's important to call `throw(error);` to avoid stopping the middleware stack. If you don't re-throw the error, it won't be handled by the Strapi's error formatter and the api will never respond to the client. ::: ## Configure the middleware -You will have to order this middleware at the end of the middleware stack. +Make sure your middleware is added at the end of the middleware stack. **Path —** `./config/middleware.json` @@ -76,7 +76,7 @@ You will have to order this middleware at the end of the middleware stack. } ``` -And fianlly you have to enable the middleware. +And finally you have to enable the middleware. **Path —** `./config/environments/**/middleware.json` diff --git a/docs/3.0.0-beta.x/guides/jwt-validation.md b/docs/3.0.0-beta.x/guides/jwt-validation.md index 73ec509333..9952c9c32b 100644 --- a/docs/3.0.0-beta.x/guides/jwt-validation.md +++ b/docs/3.0.0-beta.x/guides/jwt-validation.md @@ -1,8 +1,8 @@ # JWT validation -In this guide we will see how validate a JWT via another service. +In this guide we will see how to validate a `JWT` (JSON Web Token) with a third party service. -When you signin with the authentication route `POST /auth/local`, Strapi generate a `JWT` that let your users request your API as an authenticated user. +When you sign in with the authentication route `POST /auth/local`, Strapi generates a `JWT` which lets your users request your API as an authenticated one. ```json { @@ -15,17 +15,17 @@ When you signin with the authentication route `POST /auth/local`, Strapi generat } ``` -These users are managed in the application database and can be managed via the admin dashboard. +These users are managed in the application's database and can be managed via the admin dashboard. -We can now imagine you have a `JWT` that come from [Auth0](https://auth0.com) and you want to make sure the `JWT` is correct and allow this user to use the Strapi API endpoints. +We can now imagine you have a `JWT` that comes from [Auth0](https://auth0.com) and you want to make sure the `JWT` is correct before allowing the user to use the Strapi API endpoints. -## Customise the JWT validation function +## Customize the JWT validation function -We have to use the [customization concept](../concepts/customization.md) to update the function that validate the `JWT`. This feature is powered by the **Users & Permissions** plugin. +We have to use the [customization concept](../concepts/customization.md) to update the function that validates the `JWT`. This feature is powered by the **Users & Permissions** plugin. Here is the file we will have to customize: [permission.js](https://github.com/strapi/strapi/blob/master/packages/strapi-plugin-users-permissions/config/policies/permissions.js) -- We have now to create a file that follow this path `./extensions/users-permissions/config/policies/permissions.js`. +- We have to create a file that follows this path `./extensions/users-permissions/config/policies/permissions.js`. - You will have to add in this new file, the same content of the original one. Now we are ready to create our custom validation code. @@ -55,11 +55,11 @@ module.exports = async (ctx, next) => { } ``` -The `jwt.getToken` will throw and error it the token don't come from Strapi. So if it's not a Strapi `JWT` token, lets test if it's an Auth0 token. +The `jwt.getToken` will throw an error if the token doesn't come from Strapi. So if it's not a Strapi `JWT` token, let's test if it's an Auth0 one. We will have to write our validation code before throwing an error. -By using the [Auth0 get user profile](https://auth0.com/docs/api/authentication?http#get-user-info) documentation, I will verify a valid user match with the current `JWT` +By using the [Auth0 get user profile](https://auth0.com/docs/api/authentication?http#get-user-info) documentation, you will verify a valid user matches with the current `JWT` ```js const _ = require('lodash'); @@ -99,5 +99,5 @@ module.exports = async (ctx, next) => { ``` ::: warning -In the code example we use `axios` you will have to install the dependence to make it works or use and other library to request Auth0 API. +In the code example we use `axios` you will have to install the dependency to make it work. You can choose another library if you prefer. ::: diff --git a/docs/3.0.0-beta.x/plugins/email.md b/docs/3.0.0-beta.x/plugins/email.md index cc7d83ce96..ccfa6cdf3d 100644 --- a/docs/3.0.0-beta.x/plugins/email.md +++ b/docs/3.0.0-beta.x/plugins/email.md @@ -93,10 +93,10 @@ To use it you will have to publish it on **npm**. ### Create a local provider -If you want create your own provider without publishing it on **npm** you can follow these following steps: +If you want to create your own provider without publishing it on **npm** you can follow these steps: -- You create a `providers` folder in your application. -- Create your provider as explain in the documentation eg. `./providers/strapi-provider-email-[...]/...` +- Create a `providers` folder in your application. +- Create your provider as explained in the documentation eg. `./providers/strapi-provider-email-[...]/...` - Then update your `package.json` to link your `strapi-provider-email-[...]` dependency to the [local path](https://docs.npmjs.com/files/package.json#local-paths) of your new provider. ```json diff --git a/docs/3.0.0-beta.x/plugins/upload.md b/docs/3.0.0-beta.x/plugins/upload.md index caddb40764..10128091d5 100644 --- a/docs/3.0.0-beta.x/plugins/upload.md +++ b/docs/3.0.0-beta.x/plugins/upload.md @@ -298,10 +298,10 @@ To use it you will have to publish it on **npm**. ### Create a local provider -If you want create your own provider without publishing it on **npm** you can follow these following steps: +If you want create your own provider without publishing it on **npm** you can follow these steps: -- You create a `providers` folder in your application. -- Create your provider as explain in the documentation eg. `./providers/strapi-provider-upload-[...]/...` +- Create a `providers` folder in your application. +- Create your provider as explained in the documentation eg. `./providers/strapi-provider-upload-[...]/...` - Then update your `package.json` to link your `strapi-provider-upload-[...]` dependency to the [local path](https://docs.npmjs.com/files/package.json#local-paths) of your new provider. ```json From 3b4c00d1128700edef3326f0fe487822894242d9 Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Thu, 24 Oct 2019 15:14:05 +0200 Subject: [PATCH 10/27] Missing one typo --- docs/3.0.0-beta.x/plugins/upload.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/3.0.0-beta.x/plugins/upload.md b/docs/3.0.0-beta.x/plugins/upload.md index 10128091d5..491b573c2c 100644 --- a/docs/3.0.0-beta.x/plugins/upload.md +++ b/docs/3.0.0-beta.x/plugins/upload.md @@ -298,7 +298,7 @@ To use it you will have to publish it on **npm**. ### Create a local provider -If you want create your own provider without publishing it on **npm** you can follow these steps: +If you want to create your own provider without publishing it on **npm** you can follow these steps: - Create a `providers` folder in your application. - Create your provider as explained in the documentation eg. `./providers/strapi-provider-upload-[...]/...` From a4414502d7bf270f825c600b2ace7472293a9c2f Mon Sep 17 00:00:00 2001 From: DMehaffy Date: Thu, 24 Oct 2019 06:29:26 -0700 Subject: [PATCH 11/27] PR feedback --- docs/3.0.0-beta.x/guides/deployment.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/3.0.0-beta.x/guides/deployment.md b/docs/3.0.0-beta.x/guides/deployment.md index d74cdc201a..aebcfe1596 100644 --- a/docs/3.0.0-beta.x/guides/deployment.md +++ b/docs/3.0.0-beta.x/guides/deployment.md @@ -1544,8 +1544,6 @@ You can now continue with the [Tutorial - Creating an Admin User](../getting-sta For security reasons, the Content Type Builder plugin is disabled in production. To update content structure, please make your changes locally and deploy again. ::: ---- - ### Project updates When Strapi is deployed to Heroku, Heroku sets the environment variable to `NODE_ENV=production`. In `production mode` Strapi disables the content-type builder (for security reasons). Additionally, if you wanted to change the default production mode in Heroku, it wouldn't work as the file system is temporary. Strapi writes files to the server when you update the content-types and these updates would disappear when Heroku restarts the server. @@ -1563,8 +1561,6 @@ git push heroku master heroku open ``` ---- - ### File Uploads Like with project updates on Heroku, the file system doesn't support local uploading of files as they will be wiped when Heroku "Cycles" the dyno. This type of file system is called [ephemeral](https://devcenter.heroku.com/articles/dynos#ephemeral-filesystem), which means the file system only lasts until the dyno is restarted (with Heroku this happens any time you redeploy or during their regular restart which can happen every few hours or every day). From dc6f0c2d3e83a785fd710ed926700145fad72295 Mon Sep 17 00:00:00 2001 From: jiv_e <831144+jiv-e@users.noreply.github.com> Date: Fri, 25 Oct 2019 11:16:33 +0300 Subject: [PATCH 12/27] Update Admin panel customization documentation Update outdated Styles section. --- docs/3.0.0-beta.x/admin-panel/customization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/3.0.0-beta.x/admin-panel/customization.md b/docs/3.0.0-beta.x/admin-panel/customization.md index 4c5bc55022..0aa0ced84f 100644 --- a/docs/3.0.0-beta.x/admin-panel/customization.md +++ b/docs/3.0.0-beta.x/admin-panel/customization.md @@ -142,7 +142,7 @@ export default WysiwygWithErrors; The AdminUI package source can be easily found in `./node_modules/strapi-admin/src/`. -For example, to change the top-left displayed admin panel's color, `./node_modules/strapi-admin/admin/src/components/LeftMenuHeader/styles.scss` should be overriden by `./admin/src/components/LeftMenuHeader/styles.scss` with your own styles. +For example, to change the top-left displayed admin panel's color, copy the `./node_modules/strapi-admin/admin/src/components/LeftMenuHeader` folder to `./admin/src/components/LeftMenuHeader` and change the styles inside `./admin/src/components/LeftMenuHeader/Wrapper.js`. Thus, you are replacing the files that would normally be in `node_modules/strapi-admin/admin/src` and directing them to `admin/src/some/file/path`. From 797b14b4c6314fa863d5530822d3e0f156c4b1f9 Mon Sep 17 00:00:00 2001 From: Derrick Mehaffy Date: Fri, 25 Oct 2019 02:28:35 -0700 Subject: [PATCH 13/27] Update template links to new doc pages --- .../strapi-generate-api/templates/bookshelf/controller.template | 2 +- .../strapi-generate-api/templates/bookshelf/service.template | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/strapi-generate-api/templates/bookshelf/controller.template b/packages/strapi-generate-api/templates/bookshelf/controller.template index 73c6f64c3f..f94f22736f 100644 --- a/packages/strapi-generate-api/templates/bookshelf/controller.template +++ b/packages/strapi-generate-api/templates/bookshelf/controller.template @@ -1,7 +1,7 @@ 'use strict'; /** - * Read the documentation (https://strapi.io/documentation/3.0.0-beta.x/guides/controllers.html#core-controllers) + * Read the documentation (https://strapi.io/documentation/3.0.0-beta.x/concepts/controllers.html#core-controllers) * to customize this controller */ diff --git a/packages/strapi-generate-api/templates/bookshelf/service.template b/packages/strapi-generate-api/templates/bookshelf/service.template index 8564ba30ea..d0dcc88381 100644 --- a/packages/strapi-generate-api/templates/bookshelf/service.template +++ b/packages/strapi-generate-api/templates/bookshelf/service.template @@ -1,7 +1,7 @@ 'use strict'; /** - * Read the documentation (https://strapi.io/documentation/3.0.0-beta.x/guides/services.html#core-services) + * Read the documentation (https://strapi.io/documentation/3.0.0-beta.x/concepts/services.html#core-services) * to customize this service */ From cd218a8f496894957c5b8afe08ec4c96bee7d7ae Mon Sep 17 00:00:00 2001 From: Nguyen Tung Date: Sat, 26 Oct 2019 12:01:03 +0700 Subject: [PATCH 14/27] fix: multiple media in repeatable groups not working #4205 --- .../admin/src/containers/EditView/utils/formatData.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/strapi-plugin-content-manager/admin/src/containers/EditView/utils/formatData.js b/packages/strapi-plugin-content-manager/admin/src/containers/EditView/utils/formatData.js index 693b6e9df9..9ed0af6ca4 100644 --- a/packages/strapi-plugin-content-manager/admin/src/containers/EditView/utils/formatData.js +++ b/packages/strapi-plugin-content-manager/admin/src/containers/EditView/utils/formatData.js @@ -157,7 +157,7 @@ export const mapDataKeysToFilesToUpload = (filesMap, data) => { const groupData = get(data, [key], []); const groupFiles = groupData.reduce((acc1, current, index) => { const files = isMultiple - ? getFileToUpload([key, index, targetKey]) + ? getFilesToUpload([key, index, targetKey]) : getFileToUpload([key, index, targetKey]); if (!isEmpty(files)) { From fd2aaecac169cd7ef2a70057b36b5ff1eb074c33 Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Sat, 26 Oct 2019 15:50:31 +0200 Subject: [PATCH 15/27] Load scoped providers --- packages/strapi-plugin-email/config/functions/bootstrap.js | 2 +- packages/strapi-plugin-upload/config/functions/bootstrap.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/strapi-plugin-email/config/functions/bootstrap.js b/packages/strapi-plugin-email/config/functions/bootstrap.js index 13322ed7df..b12522a575 100644 --- a/packages/strapi-plugin-email/config/functions/bootstrap.js +++ b/packages/strapi-plugin-email/config/functions/bootstrap.js @@ -20,7 +20,7 @@ module.exports = async () => { strapi.plugins.email.config.providers = []; const installedProviders = Object.keys(strapi.config.info.dependencies) - .filter(d => d.startsWith('strapi-provider-email-')) + .filter(d => d.includes('strapi-provider-email-')) .concat('strapi-provider-email-sendmail'); for (let installedProvider of _.uniq(installedProviders)) { diff --git a/packages/strapi-plugin-upload/config/functions/bootstrap.js b/packages/strapi-plugin-upload/config/functions/bootstrap.js index b5161cfed9..307eced151 100644 --- a/packages/strapi-plugin-upload/config/functions/bootstrap.js +++ b/packages/strapi-plugin-upload/config/functions/bootstrap.js @@ -20,7 +20,7 @@ module.exports = async () => { strapi.plugins.upload.config.providers = []; const installedProviders = Object.keys(strapi.config.info.dependencies) - .filter(d => d.startsWith('strapi-provider-upload-')) + .filter(d => d.includes('strapi-provider-upload-')) .concat('strapi-provider-upload-local'); for (let installedProvider of _.uniq(installedProviders)) { From c51c6b06c5f20511b9460258ee09a8719dbf3428 Mon Sep 17 00:00:00 2001 From: Andrey Hohutkin Date: Mon, 28 Oct 2019 16:51:42 +0200 Subject: [PATCH 16/27] Lifecycle pre callbacks can be cancelled In case that any Lifecycle pre callback returns Promise.reject it will be caught by Admin UI showing error banner. It allows custom validations with Lifecycle callbacks as well Admin UI will show saving process without it in case of error inside Lifecycle callback just writing error message in log. --- packages/strapi-hook-mongoose/lib/mount-models.js | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/packages/strapi-hook-mongoose/lib/mount-models.js b/packages/strapi-hook-mongoose/lib/mount-models.js index e073efbef9..cea3e6bd6d 100644 --- a/packages/strapi-hook-mongoose/lib/mount-models.js +++ b/packages/strapi-hook-mongoose/lib/mount-models.js @@ -129,10 +129,9 @@ module.exports = ({ models, target, plugin = false }, ctx) => { if (_.isFunction(target[model.toLowerCase()][fn])) { schema.pre(key, function(next) { - target[model.toLowerCase()] + return target[model.toLowerCase()] [fn](this) - .then(next) - .catch(err => strapi.log.error(err)); + .then(next); }); } }); From 42d4543802a839fec787072b9a93e32daba593bf Mon Sep 17 00:00:00 2001 From: Andrey Hohutkin Date: Tue, 29 Oct 2019 09:41:23 +0200 Subject: [PATCH 17/27] Using returning promise instead of callbacks --- packages/strapi-hook-mongoose/lib/mount-models.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/strapi-hook-mongoose/lib/mount-models.js b/packages/strapi-hook-mongoose/lib/mount-models.js index cea3e6bd6d..0f20d27c77 100644 --- a/packages/strapi-hook-mongoose/lib/mount-models.js +++ b/packages/strapi-hook-mongoose/lib/mount-models.js @@ -130,8 +130,7 @@ module.exports = ({ models, target, plugin = false }, ctx) => { if (_.isFunction(target[model.toLowerCase()][fn])) { schema.pre(key, function(next) { return target[model.toLowerCase()] - [fn](this) - .then(next); + [fn](this); }); } }); From fb39ebecc41028fdcc29165c3bad0776daead012 Mon Sep 17 00:00:00 2001 From: Andrey Hohutkin Date: Tue, 29 Oct 2019 09:42:49 +0200 Subject: [PATCH 18/27] Cleaning --- packages/strapi-hook-mongoose/lib/mount-models.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/strapi-hook-mongoose/lib/mount-models.js b/packages/strapi-hook-mongoose/lib/mount-models.js index 0f20d27c77..9d8ba7343b 100644 --- a/packages/strapi-hook-mongoose/lib/mount-models.js +++ b/packages/strapi-hook-mongoose/lib/mount-models.js @@ -128,7 +128,7 @@ module.exports = ({ models, target, plugin = false }, ctx) => { const fn = preLifecycle[key]; if (_.isFunction(target[model.toLowerCase()][fn])) { - schema.pre(key, function(next) { + schema.pre(key, function() { return target[model.toLowerCase()] [fn](this); }); From d73e842d2faa821cd893f14222dcb1b21e3b6bea Mon Sep 17 00:00:00 2001 From: Alexandre Bodin Date: Tue, 29 Oct 2019 08:54:46 +0100 Subject: [PATCH 19/27] Improve the error message on install dependencies error in create strapi-app --- .../strapi-generate-new/lib/create-project.js | 21 ++++++++++++++++++- .../lib/utils/stop-process.js | 2 +- packages/strapi-generate-new/package.json | 1 + 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/packages/strapi-generate-new/lib/create-project.js b/packages/strapi-generate-new/lib/create-project.js index 2eb9ccf6b1..0197c24c2d 100644 --- a/packages/strapi-generate-new/lib/create-project.js +++ b/packages/strapi-generate-new/lib/create-project.js @@ -105,7 +105,26 @@ module.exports = async function createProject( await captureStderr('didNotInstallProjectDependencies', error); - stopProcess('Stopping installation'); + console.log(chalk.black.bgWhite(' Keep trying! ')); + console.log(); + console.log( + chalk.bold( + 'Oh, it seems that you encountered errors while installing dependencies in your project.' + ) + ); + console.log(`Don't give up, your project was created correctly.`); + console.log( + `Fix the issues mentionned in the installation errors and try to run the following command:` + ); + console.log(); + console.log( + `cd ${chalk.green(rootPath)} && ${chalk.cyan( + scope.useYarn ? 'yarn' : 'npm' + )} install` + ); + console.log(); + + stopProcess(); } await trackUsage({ event: 'didCreateProject', scope }); diff --git a/packages/strapi-generate-new/lib/utils/stop-process.js b/packages/strapi-generate-new/lib/utils/stop-process.js index 884cc01431..78010c9736 100644 --- a/packages/strapi-generate-new/lib/utils/stop-process.js +++ b/packages/strapi-generate-new/lib/utils/stop-process.js @@ -1,6 +1,6 @@ 'use strict'; module.exports = function stopProcess(message) { - console.error(message); + if (message) console.error(message); process.exit(1); }; diff --git a/packages/strapi-generate-new/package.json b/packages/strapi-generate-new/package.json index 219fc2778a..dbc6e3dff8 100644 --- a/packages/strapi-generate-new/package.json +++ b/packages/strapi-generate-new/package.json @@ -14,6 +14,7 @@ }, "dependencies": { "@sentry/node": "^5.7.1", + "chalk": "^2.4.2", "execa": "^1.0.0", "fs-extra": "^8.0.1", "inquirer": "^6.3.1", From 087cd34636d694599668439cc65aa72525f2d420 Mon Sep 17 00:00:00 2001 From: Jim LAURIE Date: Tue, 29 Oct 2019 17:08:36 +0100 Subject: [PATCH 20/27] Change examples --- .../3.0.0-beta.x/content-api/api-endpoints.md | 159 +++++++++++++++--- 1 file changed, 136 insertions(+), 23 deletions(-) diff --git a/docs/3.0.0-beta.x/content-api/api-endpoints.md b/docs/3.0.0-beta.x/content-api/api-endpoints.md index 5257155559..a195988f69 100644 --- a/docs/3.0.0-beta.x/content-api/api-endpoints.md +++ b/docs/3.0.0-beta.x/content-api/api-endpoints.md @@ -1,8 +1,12 @@ # API Endpoints -When you create a `Content Type` you will have a certain number of REST API endpoints available to interact with it. +When you create a `Content Type` you will have a certain number of **REST API endpoints** available to interact with it. -As an example let's consider the `Restaurant` Content Type for the next steps. +As an **example** let's consider the `Restaurant` as a **Content Type** and `Openning_hours` as a **Group** for the next steps. + +:::: tabs cache-lifetime="10" :options="{ useUrlFragment: false }" + +::: tab "Content Type" id="content-type" ### `Restaurant` Content Type @@ -12,6 +16,10 @@ As an example let's consider the `Restaurant` Content Type for the next steps. | cover | media | Restaurant's cover image | | | opening_hours | group | Restaurant's opening hours group | `repeatable` | +::: + +::: tab "Group" id="group" + ### `Opening_hours` Group | Fields | Type | Description | @@ -20,10 +28,14 @@ As an example let's consider the `Restaurant` Content Type for the next steps. | opening_hour | string | Meta's opening hour | | closing_hour | string | Meta's closing hour | ---- +::: + +:::: ## Endpoints +Here is the list of endpoints generated for each of your **Content Types** +