From 691a2ac7885eae4b753ffe3ac41722dcee564787 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Wed, 23 Jun 2021 11:26:49 +0200 Subject: [PATCH 01/11] Add consistency --- .../content-api/integrations/11ty.md | 2 +- .../content-api/integrations/angular.md | 2 +- .../content-api/integrations/dart.md | 4 +-- .../content-api/integrations/flutter.md | 4 +-- .../content-api/integrations/gatsby.md | 2 +- .../content-api/integrations/go.md | 4 +-- .../content-api/integrations/graphql.md | 2 +- .../content-api/integrations/gridsome.md | 2 +- .../content-api/integrations/jekyll.md | 2 +- .../content-api/integrations/next-js.md | 2 +- .../content-api/integrations/nuxt-js.md | 2 +- .../content-api/integrations/php.md | 4 +-- .../content-api/integrations/python.md | 2 +- .../content-api/integrations/react.md | 2 +- .../content-api/integrations/ruby.md | 2 +- .../content-api/integrations/sapper.md | 2 +- .../content-api/integrations/svelte.md | 2 +- .../content-api/integrations/vue-js.md | 2 +- .../latest/development/plugins/i18n.md | 24 +++++++++++++ .../setup-deployment-guides/configurations.md | 34 ++++++++++++++++--- .../configurations/databases/mongodb.md | 4 +-- .../setup-deployment-guides/deployment.md | 25 +++++++++++++- .../deployment/hosting-guides/21yunbox.md | 28 +++++++++++++-- .../installation/digitalocean-one-click.md | 21 ++++++++---- .../installation/platformsh.md | 24 +++++++++++++ .../installation/render.md | 24 +++++++++++++ 26 files changed, 190 insertions(+), 38 deletions(-) diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/11ty.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/11ty.md index 90a2a5211c..5909a0236b 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/11ty.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/11ty.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [11ty](https://www.11ty.dev/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [11ty](https://www.11ty.dev/) remains the same except that you will not fetch the same content. ## Create an 11ty app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/angular.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/angular.md index 04ecd728d7..a7e3aa82a2 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/angular.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/angular.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Angular](https://angular.io) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Angular](https://angular.io) remains the same except that you will not fetch the same content. ## Create a Angular app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/dart.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/dart.md index b69eeee5d5..7789bcfca4 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/dart.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/dart.md @@ -5,9 +5,9 @@ description: Build powerful applications using Strapi, the leading open-source h # Getting Started with Dart -This integration guide is following the [Getting started guide](/developer-docs/latest/getting-started/quick-start.html). We assume that you have completed [Step 8](/developer-docs/latest/getting-started/quick-start.html#_8-publish-the-content) and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). +This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Dart](https://dart.dev/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Dart](https://dart.dev/) remains the same except that you will not fetch the same content. ## Create a Dart file diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/flutter.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/flutter.md index 4671f7b68d..dd88f08ac2 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/flutter.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/flutter.md @@ -5,9 +5,9 @@ description: Build powerful applications using Strapi, the leading open-source h # Getting Started with Flutter -This integration guide is following the [Getting started guide](/developer-docs/latest/getting-started/quick-start.html). We assume that you have completed [Step 8](/developer-docs/latest/getting-started/quick-start.html#_8-publish-the-content) and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). +This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Flutter](https://flutter.dev/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Flutter](https://flutter.dev/) remains the same except that you will not fetch the same content. ## Create a Flutter application diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/gatsby.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/gatsby.md index 2160c3470c..915dab2a36 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/gatsby.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/gatsby.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Gatsby](https://www.gatsbyjs.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Gatsby](https://www.gatsbyjs.org/) remains the same except that you will not fetch the same content. ## Create a Gatsby app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/go.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/go.md index 732e93460c..cb56b8c11c 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/go.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/go.md @@ -5,9 +5,9 @@ description: Build powerful applications using Strapi, the leading open-source h # Getting Started with GO -This integration guide is following the [Getting started guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have completed [Step 8](/developer-docs/latest/getting-started/quick-start.html#_8-publish-the-content) and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). +This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [GO](https://golang.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start guide, the way you request a Strapi API with [GO](https://golang.org/) remains the same except that you will not fetch the same content. ## Create a Go file diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/graphql.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/graphql.md index 4761bd65e3..5587d87272 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/graphql.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/graphql.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [GraphQL](https://graphql.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [GraphQL](https://graphql.org/) remains the same except that you will not fetch the same content. ## Install the GraphQL plugin diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/gridsome.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/gridsome.md index 317ac16c61..e2adee7461 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/gridsome.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/gridsome.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Gridsome](https://gridsome.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Gridsome](https://gridsome.org/) remains the same except that you will not fetch the same content. ## Create a Gridsome app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/jekyll.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/jekyll.md index 97ba4b5c55..fdf464c649 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/jekyll.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/jekyll.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Jekyll](https://jekyllrb.com) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Jekyll](https://jekyllrb.com) remains the same except that you will not fetch the same content. ## Create a Jekyll app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/next-js.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/next-js.md index 01b55df7db..df27dde5b0 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/next-js.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/next-js.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Next.js](https://nextjs.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Next.js](https://nextjs.org/) remains the same except that you will not fetch the same content. ## Create a Next.js app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/nuxt-js.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/nuxt-js.md index b78670c049..2865dec7c3 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/nuxt-js.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/nuxt-js.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Nuxt.js](https://nuxtjs.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Nuxt.js](https://nuxtjs.org/) remains the same except that you will not fetch the same content. ## Create a Nuxt.js app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/php.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/php.md index a0abc41fc1..e4fe387a0a 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/php.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/php.md @@ -5,9 +5,9 @@ description: Build powerful applications using Strapi, the leading open-source h # Getting Started with PHP -This integration guide is following the [Getting started guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have completed [Step 8](/developer-docs/latest/getting-started/quick-start.html#_8-publish-the-content) and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). +This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [PHP](https://php.net/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [PHP](https://php.net/) remains the same except that you will not fetch the same content. ## Create a PHP file diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/python.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/python.md index 2e4c410539..2cb4133e76 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/python.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/python.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Python](https://www.python.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Python](https://www.python.org/) remains the same except that you will not fetch the same content. ## Create a Python file diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/react.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/react.md index d8974cbb4a..78c10ea656 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/react.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/react.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [React](https://reactjs.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [React](https://reactjs.org/) remains the same except that you will not fetch the same content. ## Create a React app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/ruby.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/ruby.md index 7d2c34d913..56c25b3ce2 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/ruby.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/ruby.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Ruby](https://www.ruby-lang.org/en/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Ruby](https://www.ruby-lang.org/en/) remains the same except that you will not fetch the same content. ## Create a Ruby file diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/sapper.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/sapper.md index 401a673818..59c28561ff 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/sapper.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/sapper.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Sapper](https://sapper.svelte.dev) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Sapper](https://sapper.svelte.dev) remains the same except that you will not fetch the same content. ## Create a Sapper app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/svelte.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/svelte.md index bab7aa2e94..73de09b030 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/svelte.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/svelte.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Svelte](https://svelte.dev) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Svelte](https://svelte.dev) remains the same except that you will not fetch the same content. ## Create a Svelte app diff --git a/docs/developer-docs/latest/developer-resources/content-api/integrations/vue-js.md b/docs/developer-docs/latest/developer-resources/content-api/integrations/vue-js.md index ce5c78c417..04f835ebf9 100644 --- a/docs/developer-docs/latest/developer-resources/content-api/integrations/vue-js.md +++ b/docs/developer-docs/latest/developer-resources/content-api/integrations/vue-js.md @@ -7,7 +7,7 @@ description: Build powerful applications using Strapi, the leading open-source h This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants). -If you haven't gone through the getting started guide, the way you request a Strapi API with [Vue.js](https://vuejs.org/) remains the same except that you will not fetch the same content. +If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Vue.js](https://vuejs.org/) remains the same except that you will not fetch the same content. ## Create a Vue.js app diff --git a/docs/developer-docs/latest/development/plugins/i18n.md b/docs/developer-docs/latest/development/plugins/i18n.md index b5ccff1c62..a7511b32ff 100644 --- a/docs/developer-docs/latest/development/plugins/i18n.md +++ b/docs/developer-docs/latest/development/plugins/i18n.md @@ -3,6 +3,30 @@ title: Internationalization (i18n) - Strapi Developer Documentation description: Instructions on how to use Strapi Content API with the Internationalization (i18n) optional plugin --- + + # 🌍 Internationalization (i18n) The Internationalization (i18n) plugin allows Strapi users to create, manage and distribute localized content in different languages, called "locales". For more information about the concept of internationalization, please refer to the diff --git a/docs/developer-docs/latest/setup-deployment-guides/configurations.md b/docs/developer-docs/latest/setup-deployment-guides/configurations.md index 8f40bedf19..c4ba626e72 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/configurations.md +++ b/docs/developer-docs/latest/setup-deployment-guides/configurations.md @@ -4,6 +4,30 @@ description: Learn how you can manage and customize the configuration of your St sidebarDepth: 3 --- + + # Configurations Your application configuration lives in the `config` folder. All the configuration files are loaded on startup and can be accessed through the configuration provider. @@ -1141,16 +1165,16 @@ The dotfiles are not exposed. It means that every file name that starts with `.` Single-Sign-On on Strapi allows you to configure additional sign-in and sign-up methods for your administration panel. -::: warning CAUTION -It is currently not possible to associate a unique SSO provider to an email address used for a Strapi account, meaning that the access to a Strapi account cannot be restricted to only one SSO provider. For more information and workarounds to solve this issue, [please refer to the dedicated GitHub issue](https://github.com/strapi/strapi/issues/9466#issuecomment-783587648). -::: - -::: warning PREREQUISITES +::: danger PREREQUISITES - A Strapi application running on version 3.5.0 or higher is required. - To configure SSO on your application, you will need an EE license with a Gold plan. - Make sure Strapi is part of the applications you can access with your provider. For example, with Microsoft (Azure) Active Directory, you must first ask someone with the right permissions to add Strapi to the list of allowed applications. Please refer to your provider(s) documentation to learn more about that. ::: +::: warning CAUTION +It is currently not possible to associate a unique SSO provider to an email address used for a Strapi account, meaning that the access to a Strapi account cannot be restricted to only one SSO provider. For more information and workarounds to solve this issue, [please refer to the dedicated GitHub issue](https://github.com/strapi/strapi/issues/9466#issuecomment-783587648). +::: + #### Usage SSO configuration lives in the server configuration of your application found within `/config/server.js`. diff --git a/docs/developer-docs/latest/setup-deployment-guides/configurations/databases/mongodb.md b/docs/developer-docs/latest/setup-deployment-guides/configurations/databases/mongodb.md index 5fb6a7e6c6..06878f9a59 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/configurations/databases/mongodb.md +++ b/docs/developer-docs/latest/setup-deployment-guides/configurations/databases/mongodb.md @@ -59,7 +59,7 @@ brew install mongodb-community@4.4 3. Get the mongod process running in order to connect and use MongoDB: -For macOS running Intel processors: +For macOS running on Intel processors: ```bash mongod --config /usr/local/etc/mongod.conf @@ -71,7 +71,7 @@ For macOS running on Apple M1 processors: mongod --config /opt/homebrew/etc/mongod.conf ``` -You have now installed MongoDB for _Mac_. You are now ready to [install Strapi with MongoDB locally](#_2-install-strapi-locally-with-mongodb). +You have now installed MongoDB for macOS. You are now ready to [install Strapi with MongoDB locally](#_2-install-strapi-locally-with-mongodb). ::: diff --git a/docs/developer-docs/latest/setup-deployment-guides/deployment.md b/docs/developer-docs/latest/setup-deployment-guides/deployment.md index 691444adf5..415418903d 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/deployment.md +++ b/docs/developer-docs/latest/setup-deployment-guides/deployment.md @@ -3,6 +3,29 @@ title: Deployment - Strapi Developer Documentation description: Learn how to develop locally with Strapi and deploy Strapi with various hosting options. --- + # Deployment Strapi gives you many possible deployment options for your project or application. Strapi can be deployed on traditional hosting servers or services such as 21YunBox, Render, Heroku, AWS, Azure and others. The following documentation covers how to develop locally with Strapi and deploy Strapi with various hosting options. @@ -13,7 +36,7 @@ Deploying **databases** along with Strapi is covered in the [Databases Guide](/d ## General guidelines -::: warning PREREQUISITES +::: danger PREREQUISITES To provide the best possible environment for Strapi there are a few requirements, these apply in both a development (local) as well as a staging and production workflow. - Node LTS (v12 or V14) **Note that odd-number releases of Node will never be supported (e.g. v13, v15).** diff --git a/docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/21yunbox.md b/docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/21yunbox.md index 8ebb2b90f8..990ce23d99 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/21yunbox.md +++ b/docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/21yunbox.md @@ -3,6 +3,30 @@ title: 21YunBox Deployment - Strapi Developer Documentation description: Learn in this guide how to update an existing Strapi project so it can be deployed on 21YunBox. --- + + # 21YunBox This guide explains how to update an existing Strapi project so it can be deployed on [21YunBox](https://www.21yunbox.com). @@ -15,13 +39,13 @@ With persistent disks and managed PostgreSQL databases, 21YunBox gives you multi For more information consult [21YunBox's Deploy Strapi guide](https://www.21yunbox.com/docs/#/deploy-strapi) ::: - -## Prerequisites +:::danger PREREQUISITES This guide assumes you already have a Strapi project to deploy. If you need a project, use the [Quick Start](/developer-docs/latest/getting-started/quick-start.md) to get started or fork 21YunBox's Strapi Examples: - [Strapi with SQLite Starter](https://gitee.com/eryiyunbox-examples/hello-strapi-sqlite) - [Strapi with Postgres Starter](https://gitee.com/eryiyunbox-examples/hello-strapi-postgres) +::: ## Setup Follow the procedure below to set up a Strapi CMS on 21YunBox: diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md b/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md index 2f9982aff1..6873b6a0aa 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md @@ -11,6 +11,21 @@ description: Quickly deploy a Strapi application on DigitalOcean by simply using Eventually this will be turned into custom blocks or VuePress components, once I understand better how markdown-it and markdown-it-custom-block work. */ + .custom-block.warning { + border-left-width: .25rem; + background-color: #f8f8f8; + border-color: #bbbbba; + /* margin-top: 2em; */ + /* margin-bottom: 2em; */ + + .custom-block-title, p, li { + color: rgb(44, 62, 80); + } + a { + color: #007eff; + } + } + .custom-block.danger { border-left-width: .25rem; background-color: rgba(129,107,250, .05); @@ -37,9 +52,6 @@ The following documentation will guide you through the one-click creation of a n DigitalOcean is a cloud platform that helps to deploy and scale applications by offering an Infrastructure as a Service (IaaS) platform for developers. - - - :::warning PREREQUISITES A DigitalOcean account is necessary to follow this installation guide. Please visit the [DigitalOcean website](https://try.digitalocean.com/strapi/) to create an account if you don't already have one. ::: @@ -53,7 +65,6 @@ A DigitalOcean account is necessary to follow this installation guide. Please vi 5. Select your virtual machine size (minimum of 2 GB/1 CPU). 6. Choose a datacenter region (closest to you or your target area). 7. Add a new SSH key. You can follow [this guide](https://docs.digitalocean.com/products/droplets/how-to/add-ssh-keys/). - 8. Give your virtual machine a hostname. 9. Click **Create Droplet**. It may take from 30 seconds to a few minutes for the droplet to start, and a few minutes more to finish the Strapi installation. @@ -68,8 +79,6 @@ To visit your Strapi application: 3. Copy the public ipv4 address of the droplet. 4. Use this address to access the Strapi application. - - Visiting the Strapi application page for the first time will require to create the first administrator user. ::: danger πŸ€“ Customization options for the DigitalOcean droplet diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/platformsh.md b/docs/developer-docs/latest/setup-deployment-guides/installation/platformsh.md index 3c284d4a59..8d5c8b889f 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/platformsh.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/platformsh.md @@ -4,6 +4,30 @@ description: Quickly deploy a Strapi application using the official Platform.sh sidebarDepth: 1 --- + + # Platform.sh One-Click The following documentation will guide you through the one-click creation of a new Strapi project hosted on [Platform.sh](https://platform.sh/). diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/render.md b/docs/developer-docs/latest/setup-deployment-guides/installation/render.md index 3c5bb4439b..cdfec06b60 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/render.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/render.md @@ -3,6 +3,30 @@ title: Render One-Click - Strapi Developer Documentation description: Quickly deploy a Strapi application on Render by simply using their One-click button. --- + + # Render One-Click The following documentation will guide you through the one-click creation of a new Strapi project hosted on [Render](https://render.com). From 45635a96344feac31e5ee136b7acedffe4c4256f Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Wed, 30 Jun 2021 17:20:02 +0200 Subject: [PATCH 02/11] 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 --- docs/.vuepress/config.js | 33 +++++++++++-------- docs/.vuepress/styles/index.styl | 4 ++- .../styles/strapi-custom-blocks.styl | 28 ++++++++++++++++ docs/package.json | 3 +- docs/yarn.lock | 2 +- 5 files changed, 54 insertions(+), 16 deletions(-) create mode 100644 docs/.vuepress/styles/strapi-custom-blocks.styl diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 4a58744d14..1d5067467b 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -378,25 +378,32 @@ module.exports = { port: 8080, description: 'The headless CMS developers love.', base: '/documentation/', - plugins: { - '@vuepress/medium-zoom': {}, - 'vuepress-plugin-element-tabs': {}, - '@vuepress/google-analytics': { + plugins: [ + ['vuepress-plugin-element-tabs', {}], + ['@vuepress/google-analytics', { ga: 'UA-54313258-1', - }, - 'check-md': { + }], + ['check-md', { ignore: checklinksIgnoredFiles, - }, - seo: { + }], + ['seo', { siteTitle: (_, $site) => $site.title, title: $page => $page.title, - }, - 'vuepress-plugin-code-copy': { + }], + ['vuepress-plugin-code-copy', { color: '#ffffff', successText: 'Copied to clipboard!', - }, - '@vuepress/back-to-top': {}, - }, + }], + ['@vuepress/back-to-top', {}], + ['vuepress-plugin-container', { + type: 'strapi', + defaultTitle: 'πŸ€“ ' + }], + ['vuepress-plugin-container', { + type: 'prerequisites', + defaultTitle: 'PREREQUISITES' + }] + ], head: [ [ 'link', diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl index 6e34e9968d..10b26c1a7d 100644 --- a/docs/.vuepress/styles/index.styl +++ b/docs/.vuepress/styles/index.styl @@ -2,4 +2,6 @@ color: $accentColor !important .el-tabs__item:not(.is-disabled):hover - color: $accentColor !important \ No newline at end of file + color: $accentColor !important + +@import "strapi-custom-blocks.styl" diff --git a/docs/.vuepress/styles/strapi-custom-blocks.styl b/docs/.vuepress/styles/strapi-custom-blocks.styl new file mode 100644 index 0000000000..1565a27eb6 --- /dev/null +++ b/docs/.vuepress/styles/strapi-custom-blocks.styl @@ -0,0 +1,28 @@ +.custom-block + .custom-block-title + font-weight 600 + margin-bottom -0.4rem + &.strapi + &.prerequisites + padding .1rem 1.5rem + margin-top 2rem + margin-bottom 2rem + border-left-width: .25rem + border-left-style solid + &.strapi + background-color rgba(129,107,250, .05) + border-color rgb(129,107,250) + .custom-block-title + color #816bfa + font-weight 700 + p, li + color #2c3e50 + a + color #007eff + &.prerequisites + background-color #f8f8f8; + border-color #bbbbba; + + +.custom-block.details + color rgb(44, 62, 80) diff --git a/docs/package.json b/docs/package.json index 338d0ad6e5..c3ce79bc87 100644 --- a/docs/package.json +++ b/docs/package.json @@ -19,7 +19,8 @@ }, "devDependencies": { "@vuepress/plugin-back-to-top": "^1.8.2", - "vuepress-plugin-check-md": "^0.0.2" + "vuepress-plugin-check-md": "^0.0.2", + "vuepress-plugin-container": "^2.1.5" }, "author": { "email": "hi@strapi.io", diff --git a/docs/yarn.lock b/docs/yarn.lock index 3fab5eab47..66d8cddb87 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -8165,7 +8165,7 @@ vuepress-plugin-code-copy@^1.0.6: resolved "https://registry.yarnpkg.com/vuepress-plugin-code-copy/-/vuepress-plugin-code-copy-1.0.6.tgz#6431dab764b48b5b203e4936d98b1943651ce4ad" integrity sha512-FiqwMtlb4rEsOI56O6sSkekcd3SlESxbkR2IaTIQxsMOMoalKfW5R9WlR1Pjm10v6jmU661Ex8MR11k9IzrNUg== -vuepress-plugin-container@^2.0.2: +vuepress-plugin-container@^2.0.2, vuepress-plugin-container@^2.1.5: version "2.1.5" resolved "https://registry.yarnpkg.com/vuepress-plugin-container/-/vuepress-plugin-container-2.1.5.tgz#37fff05662fedbd63ffd3a5463b2592c7a7f3133" integrity sha512-TQrDX/v+WHOihj3jpilVnjXu9RcTm6m8tzljNJwYhxnJUW0WWQ0hFLcDTqTBwgKIFdEiSxVOmYE+bJX/sq46MA== From cc62f4eed99b73a63d773f28bfb18dd471cee117 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Thu, 1 Jul 2021 15:18:34 +0200 Subject: [PATCH 03/11] Use :::strapi and :::prerequisites in existing docs --- .../latest/development/plugins/i18n.md | 26 +------- .../latest/getting-started/introduction.md | 51 +--------------- .../latest/getting-started/quick-start.md | 59 ++----------------- .../setup-deployment-guides/configurations.md | 26 +------- .../setup-deployment-guides/deployment.md | 25 +------- .../deployment/hosting-guides/21yunbox.md | 26 +------- .../installation/cli.md | 6 +- .../installation/digitalocean-one-click.md | 47 +-------------- .../installation/platformsh.md | 26 +------- .../installation/render.md | 26 +------- 10 files changed, 19 insertions(+), 299 deletions(-) diff --git a/docs/developer-docs/latest/development/plugins/i18n.md b/docs/developer-docs/latest/development/plugins/i18n.md index a7511b32ff..3957f47d66 100644 --- a/docs/developer-docs/latest/development/plugins/i18n.md +++ b/docs/developer-docs/latest/development/plugins/i18n.md @@ -3,30 +3,6 @@ title: Internationalization (i18n) - Strapi Developer Documentation description: Instructions on how to use Strapi Content API with the Internationalization (i18n) optional plugin --- - - # 🌍 Internationalization (i18n) The Internationalization (i18n) plugin allows Strapi users to create, manage and distribute localized content in different languages, called "locales". For more information about the concept of internationalization, please refer to the @@ -43,7 +19,7 @@ The i18n plugin does not automatically translate the users' content nor adapt th ## Installation -::: warning PREREQUISITES +::: prerequisites PREREQUISITES The Internationalization plugin is installed by default on all Strapi applications running on version 3.6.0 or higher. For lower versions, a migration is needed (see [Update Strapi version](/developer-docs/latest/update-migration-guides/update-version.md)), as well as a manual installation of the plugin. ::: diff --git a/docs/developer-docs/latest/getting-started/introduction.md b/docs/developer-docs/latest/getting-started/introduction.md index a0ca95c264..5819e12fcf 100644 --- a/docs/developer-docs/latest/getting-started/introduction.md +++ b/docs/developer-docs/latest/getting-started/introduction.md @@ -3,58 +3,11 @@ title: Strapi Developer Documentation description: This documentation contains all technical documentation related to the setup, deployment, update and customization of your Strapi application. --- - - # Welcome to the Strapi developer documentation! This documentation contains all technical documentation related to the setup, deployment, update and customization of your Strapi application. -::: danger πŸ€“ Can't wait to start using Strapi? +::: strapi πŸ€“ Can't wait to start using Strapi? You can directly head to the [Quick Start](quick-start.md)!
If demos are more your thing, we have a [video demo](https://youtu.be/zd0_S_FPzKg), or you can request a [live demo](https://strapi.io/demo)! ::: @@ -79,7 +32,7 @@ Strapi is a community-oriented project with an emphasis on transparency. The Str Community members also take great part in providing the whole community a plethora of resources about Strapi. You can find [tutorials](https://strapi.io/tutorials/) on the Strapi website, where you can also create your own. Also, as an open-source project, the technical documentation of Strapi is open to contributions (see [Open-source & Contribution](#open-source-contribution)). -::: danger πŸ€“ Want to join the community? +::: strapi πŸ€“ Want to join the community? You can join [GitHub](https://github.com/strapi/strapi) and the [forum](https://forum.strapi.io/) and share your ideas and opinions with other community members and members of the Strapi team. If you're looking for news and updates about Strapi, [Twitter](https://twitter.com/strapijs) and the [blog](https://strapi.io/blog) are pretty good places to start! ::: diff --git a/docs/developer-docs/latest/getting-started/quick-start.md b/docs/developer-docs/latest/getting-started/quick-start.md index 3ac6346ce6..dbd3b1c112 100644 --- a/docs/developer-docs/latest/getting-started/quick-start.md +++ b/docs/developer-docs/latest/getting-started/quick-start.md @@ -34,51 +34,6 @@ next: ./troubleshooting padding-left: .3em; } - /* - We override the :::warning and :::danger callouts for specific uses here. - The CSS is scoped so this won't affect the rest of the docs. - - Eventually this will be turned into custom blocks or VuePress components, - once I understand better how markdown-it and markdown-it-custom-block work. - */ - .custom-block.congrats, - .custom-block.warning, - .custom-block.danger { - border-left-width: .25rem; - } - - .custom-block.warning { - background-color: #f8f8f8; - border-color: #bbbbba; - } - - .custom-block.warning, - .custom-block.danger { - margin-top: 2em; - margin-bottom: 2em; - - .custom-block-title, p, li { - color: rgb(44, 62, 80); - } - a { - color: #007eff; - } - } - - .custom-block.danger { - background-color: rgba(129,107,250, .05); - border-color: rgb(129,107,250); - - .custom-block-title { - color: rgb(129,107,250); - font-weight: bold; - } - } - - .custom-block.details { - color: rgb(44, 62, 80); - } - @@ -136,10 +91,8 @@ next: ./troubleshooting Strapi offers a lot of flexibility. Whether you want to go fast and quickly see the final result, or would rather dive deeper into the product, we got you covered. -:::warning PREREQUISITES - +::: prerequisites Make sure [Node.js and npm are properly installed](/developer-docs/latest/setup-deployment-guides/installation/cli.md#preparing-the-installation) on your machine. It is also possible to use Yarn instead of npm (see [install the Yarn package](https://yarnpkg.com/en/)). - ::: πŸ‘‡ Let's get started! Using the big buttons below, please choose between: @@ -188,7 +141,7 @@ Once the installation is complete, your browser automatically opens 2 tabs: By completing the form in the first tab, you create your own account. Once done, you become the first administator user of this Strapi application. Welcome aboard, commander! -:::warning CONGRATULATIONS! πŸ₯³ +::: prerequisites CONGRATULATIONS! πŸ₯³ Your blog is ready! You can start playing with Strapi and discover the product by yourself using our [User Guide](/user-docs/latest/getting-started/introduction.md), or proceed to part B below. Writing a blog is not your cup of tea? You can leave this guide and play with other [Starters](https://strapi.io/starters) on your own. @@ -267,7 +220,7 @@ After a few moments, you should see your blog with its updated title running at ![GIF: Updated Gatsby blog front end](../assets/quick-start-guide/qsg-starters-part2-04-restart_servers.gif) -:::warning CONGRATULATIONS! πŸ₯³ +::: prerequisites CONGRATULATIONS! πŸ₯³ Now you know how to use Strapi to create and update your blog. Keep on creating amazing content! ::: @@ -279,7 +232,7 @@ The beauty of using Strapi [starters](https://strapi.io/starters) is that the St πŸ‘‰ Deploying the front end mostly depends on the technology it's based on. The easiest way to deploy your Gatsby blog front end is probably to [deploy on Gatsby Cloud](https://support.gatsbyjs.com/hc/en-us/articles/360052324714-Connecting-to-Strapi). -:::danger πŸ€“ To go further with starters +:::strapi πŸ€“ To go further with starters * Read more about the [starters CLI](https://strapi.io/blog/announcing-the-strapi-starter-cli) on our blog. * Start another project! We have lots of other [Starters](https://strapi.io/starters) you can use to kickstart your blog, e-commerce, corporate website, or portfolio project. @@ -318,7 +271,7 @@ You now have access to the [admin panel](http://localhost:1337/admin): ![admin panel screenshot glimpse](../assets/quick-start-guide//qsg-handson-part1-01-admin_panel.png) -:::warning πŸ₯³ CONGRATULATIONS! +::: prerequisites πŸ₯³ CONGRATULATIONS! You have just created a new Strapi project! You can start playing with Strapi and discover the product by yourself using our [User Guide](/user-docs/latest/getting-started/introduction.md), or proceed to part B below. ::: @@ -482,7 +435,7 @@ Try it now! The result should be similar to the example response below πŸ‘‡. ::: -:::warning πŸ₯³ CONGRATULATIONS! +::: prerequisites πŸ₯³ CONGRATULATIONS! Now your content is created, published, and you have permissions to request it through the API. Keep on creating amazing content! ::: diff --git a/docs/developer-docs/latest/setup-deployment-guides/configurations.md b/docs/developer-docs/latest/setup-deployment-guides/configurations.md index c4ba626e72..cbea294ff8 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/configurations.md +++ b/docs/developer-docs/latest/setup-deployment-guides/configurations.md @@ -4,30 +4,6 @@ description: Learn how you can manage and customize the configuration of your St sidebarDepth: 3 --- - - # Configurations Your application configuration lives in the `config` folder. All the configuration files are loaded on startup and can be accessed through the configuration provider. @@ -1165,7 +1141,7 @@ The dotfiles are not exposed. It means that every file name that starts with `.` Single-Sign-On on Strapi allows you to configure additional sign-in and sign-up methods for your administration panel. -::: danger PREREQUISITES +::: prerequisites PREREQUISITES - A Strapi application running on version 3.5.0 or higher is required. - To configure SSO on your application, you will need an EE license with a Gold plan. - Make sure Strapi is part of the applications you can access with your provider. For example, with Microsoft (Azure) Active Directory, you must first ask someone with the right permissions to add Strapi to the list of allowed applications. Please refer to your provider(s) documentation to learn more about that. diff --git a/docs/developer-docs/latest/setup-deployment-guides/deployment.md b/docs/developer-docs/latest/setup-deployment-guides/deployment.md index 415418903d..a2988a0e81 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/deployment.md +++ b/docs/developer-docs/latest/setup-deployment-guides/deployment.md @@ -3,29 +3,6 @@ title: Deployment - Strapi Developer Documentation description: Learn how to develop locally with Strapi and deploy Strapi with various hosting options. --- - # Deployment Strapi gives you many possible deployment options for your project or application. Strapi can be deployed on traditional hosting servers or services such as 21YunBox, Render, Heroku, AWS, Azure and others. The following documentation covers how to develop locally with Strapi and deploy Strapi with various hosting options. @@ -36,7 +13,7 @@ Deploying **databases** along with Strapi is covered in the [Databases Guide](/d ## General guidelines -::: danger PREREQUISITES +::: prerequisites PREREQUISITES To provide the best possible environment for Strapi there are a few requirements, these apply in both a development (local) as well as a staging and production workflow. - Node LTS (v12 or V14) **Note that odd-number releases of Node will never be supported (e.g. v13, v15).** diff --git a/docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/21yunbox.md b/docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/21yunbox.md index 990ce23d99..4b3bb19110 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/21yunbox.md +++ b/docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/21yunbox.md @@ -3,30 +3,6 @@ title: 21YunBox Deployment - Strapi Developer Documentation description: Learn in this guide how to update an existing Strapi project so it can be deployed on 21YunBox. --- - - # 21YunBox This guide explains how to update an existing Strapi project so it can be deployed on [21YunBox](https://www.21yunbox.com). @@ -39,7 +15,7 @@ With persistent disks and managed PostgreSQL databases, 21YunBox gives you multi For more information consult [21YunBox's Deploy Strapi guide](https://www.21yunbox.com/docs/#/deploy-strapi) ::: -:::danger PREREQUISITES +:::prerequisites PREREQUISITES This guide assumes you already have a Strapi project to deploy. If you need a project, use the [Quick Start](/developer-docs/latest/getting-started/quick-start.md) to get started or fork 21YunBox's Strapi Examples: - [Strapi with SQLite Starter](https://gitee.com/eryiyunbox-examples/hello-strapi-sqlite) diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md b/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md index eaeec71283..194a29372b 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md @@ -3,7 +3,7 @@ title: Installing from CLI - Strapi Developer Documentation description: Fast-track local install for getting Strapi running on your computer in less than a minute. --- - + --> # Installing from CLI @@ -70,7 +70,7 @@ Starting from the release of Strapi v4, MongoDB is not supported natively anymor ## Creating a Strapi project -::: danger πŸ€“ CLI installation options +::: strapi πŸ€“ CLI installation options The following installation guide covers the most basic installation option using the CLI. There are however other options that can be used when creating a new Strapi project: - Using the `--quickstart` flag at the end of the command to directly create the project in quickstart mode. diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md b/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md index 6873b6a0aa..9a4f7b37f1 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md @@ -3,56 +3,13 @@ title: DigitalOcean One-click - Strapi Developer Documentation description: Quickly deploy a Strapi application on DigitalOcean by simply using their One-click button. --- - - # DigitalOcean One-click The following documentation will guide you through the one-click creation of a new Strapi project hosted on [DigitalOcean](https://www.digitalocean.com/). DigitalOcean is a cloud platform that helps to deploy and scale applications by offering an Infrastructure as a Service (IaaS) platform for developers. -:::warning PREREQUISITES +::: prerequisites PREREQUISITES A DigitalOcean account is necessary to follow this installation guide. Please visit the [DigitalOcean website](https://try.digitalocean.com/strapi/) to create an account if you don't already have one. ::: @@ -81,6 +38,6 @@ To visit your Strapi application: Visiting the Strapi application page for the first time will require to create the first administrator user. -::: danger πŸ€“ Customization options for the DigitalOcean droplet +::: strapi πŸ€“ Customization options for the DigitalOcean droplet The DigitalOcean droplet includes everything you need to run Strapi. However, should you need to access and customize the droplet environment and change some of its settings, you may want to refer to [our dedicated documentation](/developer-docs/latest/setup-deployment-guides/installation/digitalocean-customization.md). You can also find the image generation [source code](https://github.com/strapi/one-click-deploy/tree/master/digital-ocean) on Strapi's GitHub. ::: diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/platformsh.md b/docs/developer-docs/latest/setup-deployment-guides/installation/platformsh.md index 8d5c8b889f..96c37969d7 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/platformsh.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/platformsh.md @@ -4,37 +4,13 @@ description: Quickly deploy a Strapi application using the official Platform.sh sidebarDepth: 1 --- - - # Platform.sh One-Click The following documentation will guide you through the one-click creation of a new Strapi project hosted on [Platform.sh](https://platform.sh/). Platform.sh is a Platform as a Service (PaaS) that allows the management of multiple websites and applications. In particular, it allows to quickly install and deploy a Strapi application. -::: warning PREREQUISITES +::: prerequisites PREREQUISITES A Platform.sh account is necessary to follow this installation guide. Please visit the [Platform.sh website](https://console.platform.sh/) to create an account if you don't already have one. ::: diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/render.md b/docs/developer-docs/latest/setup-deployment-guides/installation/render.md index cdfec06b60..a313159e96 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/render.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/render.md @@ -3,37 +3,13 @@ title: Render One-Click - Strapi Developer Documentation description: Quickly deploy a Strapi application on Render by simply using their One-click button. --- - - # Render One-Click The following documentation will guide you through the one-click creation of a new Strapi project hosted on [Render](https://render.com). Render is a cloud provider with persistent disks and managed PostgreSQL databases, that offers multiple different ways to store content. -::: warning PREREQUISITES +::: prerequisites PREREQUISITES A Render account is necessary to follow this installation guide. Please visit [the Render dashboard](https://dashboard.render.com) to create an account if you do not already have one. ::: From adfd4c3cd737d17b2ae8c2f72e99e66241db3344 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Fri, 2 Jul 2021 12:10:24 +0200 Subject: [PATCH 04/11] Add generic callout, tweak strapi & tip callouts, and clean config file --- docs/.vuepress/config.js | 69 ++++++++++++------- .../styles/strapi-custom-blocks.styl | 13 +++- 2 files changed, 53 insertions(+), 29 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 1d5067467b..be70aae48a 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -373,37 +373,54 @@ const checklinksIgnoredFiles = [ './developer-docs/latest/update-migration-guides/migration-guides/migration-guide-beta.20-to-3.0.0.md', // line 93 ]; +const plugins = [ + ['vuepress-plugin-element-tabs', {}], + ['@vuepress/google-analytics', { + ga: 'UA-54313258-1', + }], + ['check-md', { + ignore: checklinksIgnoredFiles, + }], + ['seo', { + siteTitle: (_, $site) => $site.title, + title: $page => $page.title, + }], + ['vuepress-plugin-code-copy', { + color: '#ffffff', + successText: 'Copied to clipboard!', + }], + ['@vuepress/back-to-top', {}], + ['vuepress-plugin-container', { + type: 'callout', + defaultTitle: '' + }], + ['vuepress-plugin-container', { + type: 'callout-alt', + defaultTitle: '' + }], + ['vuepress-plugin-container', { + type: 'strapi', + defaultTitle: '', + before: info => `

πŸ€“ ${info}

`, + after: '
' + }], + ['vuepress-plugin-container', { + type: 'tip', + before: info => `

πŸ’‘ ${info}

`, + after: '
' + }], + ['vuepress-plugin-container', { + type: 'prerequisites', + defaultTitle: 'PREREQUISITES' + }], +]; + module.exports = { title: '', port: 8080, description: 'The headless CMS developers love.', base: '/documentation/', - plugins: [ - ['vuepress-plugin-element-tabs', {}], - ['@vuepress/google-analytics', { - ga: 'UA-54313258-1', - }], - ['check-md', { - ignore: checklinksIgnoredFiles, - }], - ['seo', { - siteTitle: (_, $site) => $site.title, - title: $page => $page.title, - }], - ['vuepress-plugin-code-copy', { - color: '#ffffff', - successText: 'Copied to clipboard!', - }], - ['@vuepress/back-to-top', {}], - ['vuepress-plugin-container', { - type: 'strapi', - defaultTitle: 'πŸ€“ ' - }], - ['vuepress-plugin-container', { - type: 'prerequisites', - defaultTitle: 'PREREQUISITES' - }] - ], + plugins: plugins, head: [ [ 'link', diff --git a/docs/.vuepress/styles/strapi-custom-blocks.styl b/docs/.vuepress/styles/strapi-custom-blocks.styl index 1565a27eb6..def0c3fd6a 100644 --- a/docs/.vuepress/styles/strapi-custom-blocks.styl +++ b/docs/.vuepress/styles/strapi-custom-blocks.styl @@ -2,6 +2,8 @@ .custom-block-title font-weight 600 margin-bottom -0.4rem + &.callout + &.callout-alt &.strapi &.prerequisites padding .1rem 1.5rem @@ -19,10 +21,15 @@ color #2c3e50 a color #007eff + &.callout + &.callout-alt &.prerequisites - background-color #f8f8f8; - border-color #bbbbba; - + background-color #f8f8f8 + border-color #bbbbba + &.callout-alt + border-radius: 10px + background-color: #eff5f7 + border: none .custom-block.details color rgb(44, 62, 80) From f048b7cd9f4b1f10b84c67a2a25c271b4ae80583 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Fri, 2 Jul 2021 12:12:22 +0200 Subject: [PATCH 05/11] Clean up unused inline styles from Markdown files --- .../latest/getting-started/quick-start.md | 6 --- .../installation/cli.md | 40 ------------------- 2 files changed, 46 deletions(-) diff --git a/docs/developer-docs/latest/getting-started/quick-start.md b/docs/developer-docs/latest/getting-started/quick-start.md index dbd3b1c112..2ddd8118bf 100644 --- a/docs/developer-docs/latest/getting-started/quick-start.md +++ b/docs/developer-docs/latest/getting-started/quick-start.md @@ -65,12 +65,6 @@ next: ./troubleshooting border: solid 1px #bbbbba !important; } - .el-tabs--card > .el-tabs__header > .el-tabs__nav-wrap > .el-tabs__nav-scroll > .el-tabs__nav > .el-tabs__item.is-active { - /* border: none; */ - /* height: 62px; */ - /* border-bottom: solid 1px red !important; */ - } - .el-tabs--card > .el-tabs__header > .el-tabs__nav-wrap > .el-tabs__nav-scroll > .el-tabs__nav > .el-tabs__item:first-child { border-radius: 8px 0 0 8px !important; border-right: none !important; diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md b/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md index 194a29372b..9925c40262 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md @@ -3,46 +3,6 @@ title: Installing from CLI - Strapi Developer Documentation description: Fast-track local install for getting Strapi running on your computer in less than a minute. --- - - # Installing from CLI Strapi CLI (Command Line Interface) installation scripts are the fastest way to get Strapi running locally. The following guide is the installation option most recommended by Strapi. From 4b0f29f75ad85748f42114c10b401cac2aa24eef Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Fri, 2 Jul 2021 12:12:57 +0200 Subject: [PATCH 06/11] =?UTF-8?q?Remove=20=F0=9F=A4=93=20from=20Markdown?= =?UTF-8?q?=20files=20in=20strapi=20callouts=20as=20it's=20now=20included?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/developer-docs/latest/getting-started/quick-start.md | 2 +- .../latest/setup-deployment-guides/installation/cli.md | 2 +- .../installation/digitalocean-one-click.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/developer-docs/latest/getting-started/quick-start.md b/docs/developer-docs/latest/getting-started/quick-start.md index 2ddd8118bf..81cbcd6695 100644 --- a/docs/developer-docs/latest/getting-started/quick-start.md +++ b/docs/developer-docs/latest/getting-started/quick-start.md @@ -226,7 +226,7 @@ The beauty of using Strapi [starters](https://strapi.io/starters) is that the St πŸ‘‰ Deploying the front end mostly depends on the technology it's based on. The easiest way to deploy your Gatsby blog front end is probably to [deploy on Gatsby Cloud](https://support.gatsbyjs.com/hc/en-us/articles/360052324714-Connecting-to-Strapi). -:::strapi πŸ€“ To go further with starters +:::strapi To go further with starters * Read more about the [starters CLI](https://strapi.io/blog/announcing-the-strapi-starter-cli) on our blog. * Start another project! We have lots of other [Starters](https://strapi.io/starters) you can use to kickstart your blog, e-commerce, corporate website, or portfolio project. diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md b/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md index 9925c40262..8a10b7f848 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/cli.md @@ -30,7 +30,7 @@ Starting from the release of Strapi v4, MongoDB is not supported natively anymor ## Creating a Strapi project -::: strapi πŸ€“ CLI installation options +::: strapi CLI installation options The following installation guide covers the most basic installation option using the CLI. There are however other options that can be used when creating a new Strapi project: - Using the `--quickstart` flag at the end of the command to directly create the project in quickstart mode. diff --git a/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md b/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md index 9a4f7b37f1..879c456f38 100644 --- a/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md +++ b/docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md @@ -38,6 +38,6 @@ To visit your Strapi application: Visiting the Strapi application page for the first time will require to create the first administrator user. -::: strapi πŸ€“ Customization options for the DigitalOcean droplet +::: strapi Customization options for the DigitalOcean droplet The DigitalOcean droplet includes everything you need to run Strapi. However, should you need to access and customize the droplet environment and change some of its settings, you may want to refer to [our dedicated documentation](/developer-docs/latest/setup-deployment-guides/installation/digitalocean-customization.md). You can also find the image generation [source code](https://github.com/strapi/one-click-deploy/tree/master/digital-ocean) on Strapi's GitHub. ::: From 1497732ef653fd790277bea6b8451dea84f977c6 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Fri, 2 Jul 2021 12:16:30 +0200 Subject: [PATCH 07/11] Use generic callout for congratulations in QSG --- docs/developer-docs/latest/getting-started/quick-start.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/developer-docs/latest/getting-started/quick-start.md b/docs/developer-docs/latest/getting-started/quick-start.md index 81cbcd6695..e9ae85fe7a 100644 --- a/docs/developer-docs/latest/getting-started/quick-start.md +++ b/docs/developer-docs/latest/getting-started/quick-start.md @@ -135,7 +135,7 @@ Once the installation is complete, your browser automatically opens 2 tabs: By completing the form in the first tab, you create your own account. Once done, you become the first administator user of this Strapi application. Welcome aboard, commander! -::: prerequisites CONGRATULATIONS! πŸ₯³ +::: callout CONGRATULATIONS! πŸ₯³ Your blog is ready! You can start playing with Strapi and discover the product by yourself using our [User Guide](/user-docs/latest/getting-started/introduction.md), or proceed to part B below. Writing a blog is not your cup of tea? You can leave this guide and play with other [Starters](https://strapi.io/starters) on your own. @@ -214,7 +214,7 @@ After a few moments, you should see your blog with its updated title running at ![GIF: Updated Gatsby blog front end](../assets/quick-start-guide/qsg-starters-part2-04-restart_servers.gif) -::: prerequisites CONGRATULATIONS! πŸ₯³ +::: callout CONGRATULATIONS! πŸ₯³ Now you know how to use Strapi to create and update your blog. Keep on creating amazing content! ::: @@ -265,7 +265,7 @@ You now have access to the [admin panel](http://localhost:1337/admin): ![admin panel screenshot glimpse](../assets/quick-start-guide//qsg-handson-part1-01-admin_panel.png) -::: prerequisites πŸ₯³ CONGRATULATIONS! +::: callout πŸ₯³ CONGRATULATIONS! You have just created a new Strapi project! You can start playing with Strapi and discover the product by yourself using our [User Guide](/user-docs/latest/getting-started/introduction.md), or proceed to part B below. ::: @@ -429,7 +429,7 @@ Try it now! The result should be similar to the example response below πŸ‘‡. ::: -::: prerequisites πŸ₯³ CONGRATULATIONS! +::: callout πŸ₯³ CONGRATULATIONS! Now your content is created, published, and you have permissions to request it through the API. Keep on creating amazing content! ::: From ba3b5c2b480356be246d289144e99d88dec7e4c3 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Fri, 16 Jul 2021 09:56:38 +0200 Subject: [PATCH 08/11] Remove emoji from :::strapi as it's included --- docs/developer-docs/latest/getting-started/introduction.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer-docs/latest/getting-started/introduction.md b/docs/developer-docs/latest/getting-started/introduction.md index 5819e12fcf..4aebe82bde 100644 --- a/docs/developer-docs/latest/getting-started/introduction.md +++ b/docs/developer-docs/latest/getting-started/introduction.md @@ -7,7 +7,7 @@ description: This documentation contains all technical documentation related to This documentation contains all technical documentation related to the setup, deployment, update and customization of your Strapi application. -::: strapi πŸ€“ Can't wait to start using Strapi? +::: strapi Can't wait to start using Strapi? You can directly head to the [Quick Start](quick-start.md)!
If demos are more your thing, we have a [video demo](https://youtu.be/zd0_S_FPzKg), or you can request a [live demo](https://strapi.io/demo)! ::: @@ -32,7 +32,7 @@ Strapi is a community-oriented project with an emphasis on transparency. The Str Community members also take great part in providing the whole community a plethora of resources about Strapi. You can find [tutorials](https://strapi.io/tutorials/) on the Strapi website, where you can also create your own. Also, as an open-source project, the technical documentation of Strapi is open to contributions (see [Open-source & Contribution](#open-source-contribution)). -::: strapi πŸ€“ Want to join the community? +::: strapi Want to join the community? You can join [GitHub](https://github.com/strapi/strapi) and the [forum](https://forum.strapi.io/) and share your ideas and opinions with other community members and members of the Strapi team. If you're looking for news and updates about Strapi, [Twitter](https://twitter.com/strapijs) and the [blog](https://strapi.io/blog) are pretty good places to start! ::: From 6d6de6091357307a7cb2e4976fd969a0e88e5450 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Fri, 16 Jul 2021 10:19:37 +0200 Subject: [PATCH 09/11] Add 'note' custom callout --- docs/.vuepress/config.js | 5 +++++ docs/.vuepress/styles/strapi-custom-blocks.styl | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index be70aae48a..3d70c20696 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -409,6 +409,11 @@ const plugins = [ before: info => `

πŸ’‘ ${info}

`, after: '
' }], + ['vuepress-plugin-container', { + type: 'note', + before: info => `

✏️ ${info}

`, + after: '
' + }], ['vuepress-plugin-container', { type: 'prerequisites', defaultTitle: 'PREREQUISITES' diff --git a/docs/.vuepress/styles/strapi-custom-blocks.styl b/docs/.vuepress/styles/strapi-custom-blocks.styl index def0c3fd6a..02604db40f 100644 --- a/docs/.vuepress/styles/strapi-custom-blocks.styl +++ b/docs/.vuepress/styles/strapi-custom-blocks.styl @@ -6,6 +6,7 @@ &.callout-alt &.strapi &.prerequisites + &.note padding .1rem 1.5rem margin-top 2rem margin-bottom 2rem @@ -30,6 +31,9 @@ border-radius: 10px background-color: #eff5f7 border: none + &.note + background-color #f4fcff + border-color #0193C2 .custom-block.details color rgb(44, 62, 80) From 90728e86d800033b49b1c7fd56c571a99a452009 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Fri, 16 Jul 2021 17:09:09 +0200 Subject: [PATCH 10/11] 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') --- docs/.vuepress/config.js | 15 +++++++++++ .../styles/strapi-custom-blocks.styl | 27 ++++++++++++++++++- 2 files changed, 41 insertions(+), 1 deletion(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 3d70c20696..fb03766c64 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -414,10 +414,25 @@ const plugins = [ before: info => `

✏️ ${info}

`, after: '
' }], + ['vuepress-plugin-container', { + type: 'caution', + before: info => `

⚠️ ${info}

`, + after: '
' + }], + ['vuepress-plugin-container', { + type: 'warning', + before: info => `

${info}

`, + after: '
' + }], ['vuepress-plugin-container', { type: 'prerequisites', defaultTitle: 'PREREQUISITES' }], + ['vuepress-plugin-container', { + type: 'important', + before: info => `

οΈβœ‹ ${info}

`, + after: '
' + }], ]; module.exports = { diff --git a/docs/.vuepress/styles/strapi-custom-blocks.styl b/docs/.vuepress/styles/strapi-custom-blocks.styl index 02604db40f..8093922d9a 100644 --- a/docs/.vuepress/styles/strapi-custom-blocks.styl +++ b/docs/.vuepress/styles/strapi-custom-blocks.styl @@ -7,6 +7,11 @@ &.strapi &.prerequisites &.note + &.tip + &.important + &.warning + &.danger + &.caution padding .1rem 1.5rem margin-top 2rem margin-bottom 2rem @@ -32,8 +37,28 @@ background-color: #eff5f7 border: none &.note - background-color #f4fcff + // background-color #f4fcff + background-color #f3f5f7 border-color #0193C2 + &.important + border-color #DDA537 + background-color #F3F5F7 + &.caution + border-color #E7C000 + background-color rgba(255,229,100,.3) + color #6b5900 + .custom-block-title + color #B29400 + a + color #2c3e50 + &.warning + border-color #cc0000 + background-color rgb(255, 230, 230) + color #4d0000 + .custom-block-title + color #900 + a + color #2c3e50 .custom-block.details color rgb(44, 62, 80) From b55e21ed9eeec39c1d41b8cb73c96e4a5e36822a Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Mon, 19 Jul 2021 11:50:29 +0200 Subject: [PATCH 11/11] Remove important callout & cleanup CSS We decided that we'll go with a unique callout, "caution". The title can still be adjusted when necessary. --- docs/.vuepress/config.js | 9 ++------- docs/.vuepress/styles/strapi-custom-blocks.styl | 9 +++------ 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index fb03766c64..3a2b9d29e3 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -416,23 +416,18 @@ const plugins = [ }], ['vuepress-plugin-container', { type: 'caution', - before: info => `

⚠️ ${info}

`, + before: info => `

βœ‹ ${info}

`, after: '
' }], ['vuepress-plugin-container', { type: 'warning', - before: info => `

${info}

`, + before: info => `

⚠️ ${info}

`, after: '
' }], ['vuepress-plugin-container', { type: 'prerequisites', defaultTitle: 'PREREQUISITES' }], - ['vuepress-plugin-container', { - type: 'important', - before: info => `

οΈβœ‹ ${info}

`, - after: '
' - }], ]; module.exports = { diff --git a/docs/.vuepress/styles/strapi-custom-blocks.styl b/docs/.vuepress/styles/strapi-custom-blocks.styl index 8093922d9a..5045ededa0 100644 --- a/docs/.vuepress/styles/strapi-custom-blocks.styl +++ b/docs/.vuepress/styles/strapi-custom-blocks.styl @@ -8,7 +8,6 @@ &.prerequisites &.note &.tip - &.important &.warning &.danger &.caution @@ -37,12 +36,8 @@ background-color: #eff5f7 border: none &.note - // background-color #f4fcff - background-color #f3f5f7 + background-color #f4fcff border-color #0193C2 - &.important - border-color #DDA537 - background-color #F3F5F7 &.caution border-color #E7C000 background-color rgba(255,229,100,.3) @@ -59,6 +54,8 @@ color #900 a color #2c3e50 + &.tip + background-color #EFFDF6 .custom-block.details color rgb(44, 62, 80)