提交 6dd78863 编写于 作者: J Jim LAURIE

Rename docs version name

上级 5df6f161
......@@ -53,7 +53,7 @@ The core team will review your pull request and will either merge it, request ch
To facilitate the contribution, we have drastically reduced the amount of commands necessary to install the entire development environment.
First of all, you need to check if you're using the [required versions of Node.js and npm](https://strapi.io/documentation/3.x.x/getting-started/install-requirements.html)
First of all, you need to check if you're using the [required versions of Node.js and npm](https://strapi.io/documentation/3.0.0-beta.x/getting-started/install-requirements.html)
Then, please follow the instructions below:
......
......@@ -40,7 +40,7 @@ Strapi is a free and open-source Headless CMS delivering your content anywhere y
## Getting Started
<a href="https://strapi.io/documentation/3.x.x/getting-started/quick-start.html" target="_blank">Read the Getting Started tutorial</a> or follow the steps below:
<a href="https://strapi.io/documentation/3.0.0-beta.x/getting-started/quick-start.html" target="_blank">Read the Getting Started tutorial</a> or follow the steps below:
#### 🖐 Requirements
......
......@@ -59,7 +59,7 @@ module.exports = {
themeConfig: {
versions: [
['Version 3.0.0-beta.x', '/3.0.0-beta.x/'],
['Version 3.x.x', '/3.x.x/'],
['Version 3.0.0-alpha.x', '/3.0.0-alpha.x/'],
['Version 1.x.x', '/1.x.x/'],
],
repo: 'strapi/strapi',
......@@ -157,76 +157,76 @@ module.exports = {
],
},
],
'/3.x.x/': [
'/3.0.0-alpha.x/': [
{
collapsable: false,
title: '🚀 Getting started',
children: [
'/3.x.x/getting-started/introduction',
'/3.x.x/getting-started/install-requirements',
'/3.x.x/getting-started/quick-start',
'/3.x.x/getting-started/quick-start-tutorial',
'/3.0.0-alpha.x/getting-started/introduction',
'/3.0.0-alpha.x/getting-started/install-requirements',
'/3.0.0-alpha.x/getting-started/quick-start',
'/3.0.0-alpha.x/getting-started/quick-start-tutorial',
],
},
{
collapsable: true,
title: '💡 Guides',
children: [
'/3.x.x/concepts/concepts',
'/3.x.x/guides/api-documentation',
'/3.x.x/guides/authentication',
'/3.x.x/configurations/configurations',
'/3.x.x/guides/controllers',
'/3.x.x/guides/databases',
'/3.x.x/guides/deployment',
'/3.x.x/guides/email',
'/3.x.x/guides/upload',
'/3.x.x/guides/filters',
'/3.x.x/guides/graphql',
'/3.x.x/guides/i18n',
'/3.x.x/guides/models',
'/3.x.x/guides/policies',
'/3.x.x/guides/public-assets',
'/3.x.x/guides/requests',
'/3.x.x/guides/responses',
'/3.x.x/guides/routing',
'/3.x.x/guides/services',
'/3.x.x/guides/webhooks',
'/3.0.0-alpha.x/concepts/concepts',
'/3.0.0-alpha.x/guides/api-documentation',
'/3.0.0-alpha.x/guides/authentication',
'/3.0.0-alpha.x/configurations/configurations',
'/3.0.0-alpha.x/guides/controllers',
'/3.0.0-alpha.x/guides/databases',
'/3.0.0-alpha.x/guides/deployment',
'/3.0.0-alpha.x/guides/email',
'/3.0.0-alpha.x/guides/upload',
'/3.0.0-alpha.x/guides/filters',
'/3.0.0-alpha.x/guides/graphql',
'/3.0.0-alpha.x/guides/i18n',
'/3.0.0-alpha.x/guides/models',
'/3.0.0-alpha.x/guides/policies',
'/3.0.0-alpha.x/guides/public-assets',
'/3.0.0-alpha.x/guides/requests',
'/3.0.0-alpha.x/guides/responses',
'/3.0.0-alpha.x/guides/routing',
'/3.0.0-alpha.x/guides/services',
'/3.0.0-alpha.x/guides/webhooks',
],
},
{
collapsable: true,
title: '⚙️️ Advanced',
children: [
'/3.x.x/advanced/customize-admin',
'/3.x.x/advanced/hooks',
'/3.x.x/advanced/logging',
'/3.x.x/advanced/middlewares',
'/3.x.x/advanced/usage-information',
'/3.0.0-alpha.x/advanced/customize-admin',
'/3.0.0-alpha.x/advanced/hooks',
'/3.0.0-alpha.x/advanced/logging',
'/3.0.0-alpha.x/advanced/middlewares',
'/3.0.0-alpha.x/advanced/usage-information',
],
},
{
collapsable: true,
title: '🔌 Plugin Development',
children: [
'/3.x.x/plugin-development/quick-start',
'/3.x.x/plugin-development/plugin-architecture',
'/3.x.x/plugin-development/backend-development',
'/3.x.x/plugin-development/frontend-development',
'/3.x.x/plugin-development/frontend-use-cases',
'/3.x.x/plugin-development/utils',
// '/3.x.x/plugin-development/ui-components', TODO: Add this file
'/3.0.0-alpha.x/plugin-development/quick-start',
'/3.0.0-alpha.x/plugin-development/plugin-architecture',
'/3.0.0-alpha.x/plugin-development/backend-development',
'/3.0.0-alpha.x/plugin-development/frontend-development',
'/3.0.0-alpha.x/plugin-development/frontend-use-cases',
'/3.0.0-alpha.x/plugin-development/utils',
// '/3.0.0-alpha.x/plugin-development/ui-components', TODO: Add this file
],
},
{
collapsable: true,
title: '💻 Command Line Interface',
children: ['/3.x.x/cli/CLI'],
children: ['/3.0.0-alpha.x/cli/CLI'],
},
{
collapsable: true,
title: '🏗 API Reference',
children: ['/3.x.x/api-reference/reference'],
children: ['/3.0.0-alpha.x/api-reference/reference'],
},
{
collapsable: false,
......@@ -236,8 +236,8 @@ module.exports = {
'https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md',
'Contributing guide',
],
'/3.x.x/migration-guide/',
'/3.x.x/articles/',
'/3.0.0-alpha.x/migration-guide/',
'/3.0.0-alpha.x/articles/',
],
},
],
......
......@@ -120,5 +120,5 @@ npm -v
---
::: tip NEXT STEPS
👏 Congrats, you are all set! Now that Node.js is installed you can proceed to the [Quick start](/3.x.x/getting-started/quick-start.html).
👏 Congrats, you are all set! Now that Node.js is installed you can proceed to the [Quick start](/3.0.0-alpha.x/getting-started/quick-start.html).
:::
# Tutorial
# Tutorial
This Tutorial is written for developers who prefer a more detailed step-by-step introduction. (A less detailed introduction can be found at [Quick Start Guide](/3.x.x/getting-started/quick-start.html).)
This Tutorial is written for developers who prefer a more detailed step-by-step introduction. (A less detailed introduction can be found at [Quick Start Guide](/3.0.0-alpha.x/getting-started/quick-start.html).)
<div class="video-container">
<iframe width="800" height="450" src="https://www.youtube.com/embed/nux0djdHmY8" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
By following this tutorial, we will get Strapi installed globally onto your system, and then create your first Strapi project.
By following this tutorial, we will get Strapi installed globally onto your system, and then create your first Strapi project.
::: tip NOTE
You need to have ***Node.js and npm*** installed on your system prior to following these steps. If you do not have Node.js and npm installed or are not sure, please visit our [Installation Requirements](http://localhost:8080/documentation/3.x.x/getting-started/install-requirements.html).
You need to have ***Node.js and npm*** installed on your system prior to following these steps. If you do not have Node.js and npm installed or are not sure, please visit our [Installation Requirements](http://localhost:8080/documentation/3.0.0-alpha.x/getting-started/install-requirements.html).
:::
......@@ -151,11 +151,11 @@ From here you can add and edit users.
## 4. Create a Content Type
At this point, your project is empty. You need to create a **Content Type**.
At this point, your project is empty. You need to create a **Content Type**.
We can define a **Content Type** as a collection of entered data represented by fields. For example, a **Content Type** called `restaurant` may be intended to display information regarding restaurants. A `restaurant` has a `name`, a main `image`, a `description`, maybe even a link to the `restaurant menu`.
We can define a **Content Type** as a collection of entered data represented by fields. For example, a **Content Type** called `restaurant` may be intended to display information regarding restaurants. A `restaurant` has a `name`, a main `image`, a `description`, maybe even a link to the `restaurant menu`.
Another example, is a **Content Type** called `menu` which is made up of `menu items`. These have a `name`, `description of the menu item`, an `image` and perhaps even a `list of ingredients`.
Another example, is a **Content Type** called `menu` which is made up of `menu items`. These have a `name`, `description of the menu item`, an `image` and perhaps even a `list of ingredients`.
Any collection of entered data that can have fields can be a **Content Type**. They allow you to manage a class of information in an organized manner.
......@@ -177,7 +177,7 @@ Content Type `name` is always **singular**. For example, `restaurant` not `resta
The Restaurant Content Type will have a **String** field for the restaurant name, and a **Text** field (with a **WYSIWYG editor**) for the restaurant description.
1. Let's now add a content type.
1. Let's now add a content type.
Click the **"+ Add Content Type"** button.
......@@ -400,5 +400,5 @@ Forbidden Access Looks like this:
- 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.
- [Join the vibrant and active Strapi community](https://slack.strapi.io) on Slack.
- [Join the vibrant and active Strapi community](https://slack.strapi.io) on Slack.
:::
......@@ -174,7 +174,7 @@ You can add all the entries listed in the [specification](https://swagger.io/spe
],
"externalDocs": {
"description": "Find out more",
"url": "https://strapi.io/documentation/3.x.x/"
"url": "https://strapi.io/documentation/3.0.0-alpha.x/"
},
"security": [ // This field is important to add your jwt token in the SWAGGER UI
{
......
......@@ -3,7 +3,7 @@
Strapi gives you the option to choose the most appropriate database for your project. It currently supports **PostgreSQL**, **MongoDB**, **SQLite**, **MySQL** and
**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).
(Deploying **Strapi** itself is covered in the [Deployment Guide](/3.x.x/guides/deployment.html).)
(Deploying **Strapi** itself is covered in the [Deployment Guide](/3.0.0-alpha.x/guides/deployment.html).)
**Table of contents:**
......@@ -15,7 +15,7 @@ Strapi gives you the option to choose the most appropriate database for your pro
## SQLite Installation
SQLite is the default ([Quick Start](/3.x.x/getting-started/quick-start.html)) and recommended database to quickly create an app locally.
SQLite is the default ([Quick Start](/3.0.0-alpha.x/getting-started/quick-start.html)) and recommended database to quickly create an app locally.
### Install SQLite locally
......@@ -25,7 +25,7 @@ Simply use the `strapi new my-project --quickstart` command.
strapi new my-project --quickstart
```
This will create a new project and launch it in the browser. (The [Quick Start Guide](/3.x.x/getting-started/quick-start.html) is a complete step-by-step tutorial.)
This will create a new project and launch it in the browser. (The [Quick Start Guide](/3.0.0-alpha.x/getting-started/quick-start.html) is a complete step-by-step tutorial.)
## MongoDB Installation
......@@ -33,7 +33,7 @@ This will create a new project and launch it in the browser. (The [Quick Start G
In order to use Strapi with [MongoDB](https://www.mongodb.com/) in production, you must have and use MongoDB on your local development environment. These instructions show how to start using Strapi with a MongoDB database.
- You must have [Strapi installed globally](/3.x.x/getting-started/quick-start-tutorial.html#_1-install-strapi-globally).
- You must have [Strapi installed globally](/3.0.0-alpha.x/getting-started/quick-start-tutorial.html#_1-install-strapi-globally).
### 1. Install MongoDB on your development environment
......@@ -148,7 +148,7 @@ You have now installed MongoDB for _Linux_. You are now ready to [install Strapi
### 2. Install Strapi locally with MongoDB
Follow these steps to create a Strapi project locally using the MongoDB database.
Follow these steps to create a Strapi project locally using the MongoDB database.
**Note:** MongoDB must already be running in the background.
......@@ -163,21 +163,21 @@ strapi new my-project
- Use your `down arrow` key and select `Custom (manual settings)` and press `enter`:
```bash
? Choose your installation type
Quickstart (recommended)
❯ Custom (manual settings)
? Choose your installation type
Quickstart (recommended)
❯ Custom (manual settings)
```
- Select `MongoDB` and press `enter`:
```bash
? Choose your installation type Custom (manual settings)
? Choose your main database:
SQLite
❯ MongoDB
MySQL
Postgres
```
? Choose your main database:
SQLite
❯ MongoDB
MySQL
Postgres
```
- Press `enter` to select the remaining default options. It will look something like this:
......@@ -189,9 +189,9 @@ strapi new my-project
? Host: 127.0.0.1
? +srv connection: false
? Port (It will be ignored if you enable +srv): 27017
? Username:
? Password:
? Authentication database (Maybe "admin" or blank):
? Username:
? Password:
? Authentication database (Maybe "admin" or blank):
? Enable SSL connection: false
⏳ Testing database connection...
......@@ -217,7 +217,7 @@ $ strapi start
```
You have successfully installed Strapi with MongoDB on your local development environment. You are now ready to [create your first user](/3.x.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](/3.0.0-alpha.x/getting-started/quick-start.html#_3-create-an-admin-user).
---
......@@ -225,24 +225,24 @@ 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.x.x/guides/databases.html#install-strapi-locally-with-mongodb).
- You must have already [created your Strapi project using MongoDB](/3.0.0-alpha.x/guides/databases.html#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**
- First you need to `Create a new Project`.
- Then click `Build a Cluster`, from the options page:
- Choose **AWS** as your **Cloud Provider & Region**.
- Then click `Build a Cluster`, from the options page:
- Choose **AWS** as your **Cloud Provider & Region**.
- Select a **Region**. (Note: some **Regions** do not have a _free tier_.)
- In **Cluster Tier**, select **Shared Sandbox**, _Tier_ `MO`.
- In **Cluster Name**, name your cluster.
- Click the green `Create Cluster` button. You will get a message that says, "*Your cluster is being created...*"
2. Next, click on the `Security` tab (next to `Overview`):
- Click the green `+ ADD NEW USER` button:
- Click the green `+ ADD NEW USER` button:
- Enter a `username`.
- Enter a `password`.
- Under `User Privileges` ensure **`Read and write to any database`** is selected. Then click `Add User` to save.
3. Then `whitelist` your IP address. Under `Security`, click to `IP Whitelist`
- Click the green `+ ADD IP ADDRESS`
- Next click `ALLOW ACCESS FROM ANYWHERE`. **Note:** In permanent projects you would configure this with the appropriate IP addresses.
......@@ -254,7 +254,7 @@ MongoDB Atlas automatically exposes the database credentials into a single envir
- Under the `Overview` tab, click `CONNECT` and then `Connect Your Application`.
- Under `1. Choose your driver version`, select **DRIVER** as `Node.js` and **VERSION** as `2.2.12 or later`.
- This should show a **Connection String Only** similar to this:
`mongodb://paulbocuse:<password>@strapi-heroku-shard-00-00-o777o.mongodb.net:27017,strapi-heroku-shard-00-01-o606o.mongodb.net:27017,strapi-heroku-shard-00-02-o606o.mongodb.net:27017/test?ssl=true&replicaSet=Strapi-Heroku-shard-0&authSource=admin&retryWrites=true`
- You are interested in everything **AFTER** the **@** symbol. This is your **Database Host** variable. So in this case,
......@@ -263,7 +263,7 @@ MongoDB Atlas automatically exposes the database credentials into a single envir
- You created earlier a `cluster name`, `username` and `password`. These are the other variables needed to configure your project to connect to MongoDB Atlas.
Keep these five MongoDB Atlas database variables from your MongoDB Atlas account ready and available.
Keep these five MongoDB Atlas database variables from your MongoDB Atlas account ready and available.
5. Update your database config file
......
......@@ -2,7 +2,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.
(Deploying **databases** along with Strapi is covered in the [Databases Guide](/3.x.x/guides/databases.html).)
(Deploying **databases** along with Strapi is covered in the [Databases Guide](/3.0.0-alpha.x/guides/databases.html).)
**Table of contents:**
......@@ -87,7 +87,7 @@ If you want to host the administration on another server than the API, [please t
## 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.x.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](/3.0.0-alpha.x/getting-started/quick-start.html).
### Digital Ocean Install Requirements
......@@ -319,7 +319,7 @@ NODE_ENV=production npm run start
```
Minimumly, [create an admin user](http://localhost:8080/documentation/3.x.x/getting-started/quick-start.html#_3-create-an-admin-user).
Minimumly, [create an admin user](http://localhost:8080/documentation/3.0.0-alpha.x/getting-started/quick-start.html#_3-create-an-admin-user).
You will next need to [install and configure PM2 Runtime](#install-and-configure-pm2-runtime).
......@@ -620,11 +620,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.x.x/getting-started/quick-start.html) (if you want to deploy an existing project go to step 4).
Create a [new Strapi project](/3.0.0-alpha.x/getting-started/quick-start.html) (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.x.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](/3.0.0-alpha.x/guides/databases.html#install-mongodb-locally) then, jump to step 4.
:::
......@@ -783,11 +783,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 in production](/3.x.x/guides/databases.html#install-on-atlas-mongodb-atlas).
You must have completed the [steps to use Strapi with MongoDB Atlas in production](/3.0.0-alpha.x/guides/databases.html#install-on-atlas-mongodb-atlas).
##### 1. Set environment variables
When you [set-up your MongoDB Atlas database](/3.x.x/guides/databases.html#install-on-atlas-mongodb-atlas) you created and noted the five key/value pairs that correspond to your **MongoDB Atlas** database. These five keys are: `DATABASE_NAME`, `DATABASE_USERNAME`, `DATABASE_PASSWORD`, `DATABASE PORT`, and `DATABASE_HOST`.
When you [set-up your MongoDB Atlas database](/3.0.0-alpha.x/guides/databases.html#install-on-atlas-mongodb-atlas) you created and noted the five key/value pairs that correspond to your **MongoDB Atlas** database. These five keys are: `DATABASE_NAME`, `DATABASE_USERNAME`, `DATABASE_PASSWORD`, `DATABASE PORT`, and `DATABASE_HOST`.
Strapi expects a variable for each database connection detail (host, username, etc.). So, from **MongoDB Atlas**, you have to set the environment variables in the Heroku config (for **DATABASE_HOST** you need to surround the URL with **""**, and set **DATABASE_PORT** to nothing):
......@@ -857,7 +857,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.x.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](/3.0.0-alpha.x/getting-started/quick-start-tutorial.html#_3-create-an-admin-user), if you have any questions on how to proceed.
::: warning NOTE
For security reasons, the Content Type Builder plugin is disabled in production. To update content structure, please make your changes locally and deploy again.
......