Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Getting Started Tutorial #3907

Merged
merged 10 commits into from
Sep 12, 2019
Merged

Documentation Getting Started Tutorial #3907

merged 10 commits into from
Sep 12, 2019

Conversation

davidkartuzinski
Copy link
Contributor

Description of what you did:

This updated Getting Started Tutorial makes the major changes necessary for the new Groups and Repeatable Fields release:

In addition, the tutorial was almost completely rewritten to follow the upcoming style guide, better photos, and a more consistent tone.

My PR is a:

  • 💥 Breaking change
  • 🐛 Bug fix
  • 💅 Enhancement
  • 🚀 New feature

Main update on the:

  • Admin
  • Documentation
  • Framework
  • Plugin

Manual testing done on the following databases:

  • Not applicable
  • MongoDB
  • MySQL
  • Postgres
  • SQLite

Path: `~/Desktop/Projects/`

Use **only one** of the following commands to create a new Strapi project:

---

- (Using **yarn** to install the Strapi project (**recommended**). [Install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).)
- (Use **yarn** to install the Strapi project (**recommended**). [Install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not need () for all the line

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The corrections have been done.

```

**or**

- (Using **npm/npx** to install the Strapi project.)
- (Use **npm/npx** to install the Strapi project.)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same on this line

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All parenthesis () have been removed as per instructions.

:::

You are now ready to create a new **Administrator** and new front-end **User**.

## 2. Create an Adminstrator and front-end User

The first step is to create an **Administrator** (or "root user") for your project. An **Administrator** has all administrator privileges and access rights. You will need to complete the following fields:
The first step is to create an **Administrator** (or "root user") for your project. An **Administrator** has all administrator privileges and access rights. (You can read more about why **Administrators** and front-end **Users** are separate [here](https://blog.strapi.io/why-we-split-the-management-of-the-admin-users-and-end-users/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing ) at the end of the sentence.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. Good catch


You are now at the screen to add fields for your **Restaurant Content Type**.
- Click on the `String` field
- In the **Name** field, type `Restaurant_Name`. This field is the name of the restaurant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you change the attribute name?

If you follow FoodAdvisor restaurant model you can use the same attribute name.

As you can see, we never use upper case letter in attributes name (but why not _ if needed)

This comment is for all other attributes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All attributes that were named without "_" have been changed.

@lauriejim lauriejim changed the base branch from docs/tutorial to develop September 9, 2019 09:15
@lauriejim lauriejim changed the base branch from develop to master September 9, 2019 11:39

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.
- Click on the `String` field
- In the **Name** field, type `name`. This field is the name of the restaurant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image here has a blue background (because of your auto insert)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed this and the user image. Thank you.

At this point, your project is empty. You need to create a new **Content Type**.
### The Restaurant Content Type

- Go to the **Content Type Builder** plugin, located in the left menu: Under **PLUGINS**: --> **Content Type Builder**. You are now able to see the three available **Content Types**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You never use . at the end of all list lines. Expect here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These have all been fixed now.

Copy link
Contributor

@lauriejim lauriejim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good - waiting for the video

@davidkartuzinski
Copy link
Contributor Author

This is now ready to be merged.

Copy link
Contributor

@lauriejim lauriejim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lauriejim lauriejim added this to the 3.0.0-beta.17 milestone Sep 12, 2019
@lauriejim lauriejim merged commit 3a50178 into strapi:master Sep 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
source: docs Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants