-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Introduction to the User Guide #8
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
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
bf7933a
Write introduction for user guide
meganelacheny 14e3906
Create file + write documentation about accessing admin panel
meganelacheny d1b5a99
Create file for documentation about setting up profile
meganelacheny 462e93a
Update TOC with new file + Try user guide structure
meganelacheny b5e3149
Write introduction for user guide
meganelacheny 6e34955
Create file + write documentation about accessing admin panel
meganelacheny 4cb000d
Create file for documentation about setting up profile
meganelacheny 8eb7152
Update TOC with new file + Try user guide structure
meganelacheny fea9704
Merge remote-tracking branch 'origin/user-guide-creation' into user-g…
derrickmehaffy c21de79
Complete and improve User Guide Introduction
meganelacheny a5a6c04
Improve Accessing Admin Panel + Add screenshot
meganelacheny e5611dd
Write User Profile documentation + Add screenshot
meganelacheny 56b6a65
Restructure all files + Replace bad screenshot
meganelacheny ae5b7a9
Remove emojis from main TOC
meganelacheny fad91b5
Proofread + Improve
meganelacheny 8e421c4
Improve after reviews
meganelacheny 7cf7b46
Improve again after more reviews
meganelacheny eb97496
More improvements after more reviews
meganelacheny 2b5c770
Fix wording issues
meganelacheny File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,64 @@ | ||
# Welcome to the Strapi user documentation! | ||
# Welcome to the Strapi user guide! | ||
|
||
**Strapi is the open-source [Headless CMS](https://strapi.io) developers love.** | ||
This user guide contains the functional documentation related to all features available in the admin panel of your Strapi application. | ||
|
||
 | ||
|
||
Before going any further into this user guide, we recommend you to acknowledge the main concepts below. They will help you to understand how Strapi works, and ensure a smooth Strapi experience. | ||
|
||
- **Development, Staging or Production Environment** <br> When you start working on your application, it is in a development environment, which is the status for the content structuration and application configuration phase. After deploying your application, it is in production or staging. This status change impacts how you can use your Strapi application, as some features are only available in development environment, such as the Content-Types Builder. In the user guide, the availability or not of a feature, depending on the application status, is always mentioned in the feature's introduction. | ||
|
||
- **Versions** <br> Strapi is constantly evolving and growing. This implies that new releases are quite frequent, to improve what is already available but also to add new features to Strapi. For every new Strapi version, we communicate through our main channels and by sending notifications both on your terminal (when launching your Strapi application), and on your application's admin panel. We always recommend to use the latest version, especially since our documentation, including this user guide, are only aligned with the latest<!-- (see Update Strapi version or refer to our migration guides to update your Strapi application) -->. If you are on an older version of Strapi, some information in this documentation may not apply to your application. | ||
|
||
- **Roles and Permissions** <br> Some features of the admin panel, as well as the content managed with Strapi itself, are ruled by a system of permissions. From your Strapi admin panel, you have the possibility to define, at a detailed level, the roles and permissions of all administrators and end-users. In this user guide, all features and possible options are documented. It is however possible, depending on your role and permissions, that you may not be able to access all these features and options. In that case, please refer to the main Super Admin of your Strapi application. | ||
meganelacheny marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
With all this in mind, you should be ready to start your Strapi experience! | ||
|
||
|
||
## Accessing the admin panel | ||
|
||
The admin panel is the back office of your Strapi application. From the admin panel, you will be able to manage content types, and write their actual content. It is also from the admin panel that you will manage users, both administrators and end-users of your Strapi application. | ||
|
||
::: warning IMPORTANT | ||
In order to access the admin panel, your Strapi application must be launched<!-- (see Installing Strapi) -->, and you must be aware of the URL to its admin panel (e.g. `api.example.com/admin`). | ||
::: | ||
|
||
 | ||
|
||
To access the admin panel: | ||
meganelacheny marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. Go to the URL of your Strapi application's admin panel. | ||
2. Enter your credentials to log in. | ||
3. Click on the **Log in** button. You should be redirected to the homepage of the admin panel. | ||
|
||
|
||
## Setting up your administrator profile | ||
|
||
If you are a new administrator, we recommend making sure your profile is all set, before diving into your Strapi application. From your administrator profile, you are able to modify your user information, such as name, username, email or password. | ||
|
||
 | ||
|
||
To modify your user information: | ||
|
||
1. Click on your user name in the top right hand corner of the admin panel. | ||
meganelacheny marked this conversation as resolved.
Show resolved
Hide resolved
|
||
2. In the drop-down menu, click on **Profile**. | ||
3. Modify the information of your choice: | ||
|
||
| User information | Instructions | | ||
meganelacheny marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ---------------------- |----------------------------------------------------------------------------------------------------------| | ||
| First name | Write your first name in the textbox. | | ||
| Last name | Write your last name in the textbox. | | ||
| Email | Write your complete email address in the textbox. | | ||
| Username | (optional) Write a username in the textbox. | | ||
| Password | Write a new password in the textbox. You can click on the eye icon for the password to be shown. | | ||
| Confirmation password | Write the same new password in the textbox. You can click on the eye icon for the password to be shown. | | ||
|
||
4. Click on the **Save** button. | ||
|
||
*** | ||
|
||
Congratulations on being a new Strapi user! You're now ready to discover all the features and options that Strapi has to offer! | ||
|
||
::: tip 💡 TIP | ||
If you have any trouble with your Strapi experience, you can reach us through [GitHub](https://github.com/strapi/) or our [forum](https://forum.strapi.io/)! The Strapi Community and Strapi team are always available to answer your questions or help you with anything! | ||
::: |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.