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

New CMS documentation - Improvements & Additions (WIP) #2359

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions docusaurus/docs/cloud/getting-started/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,24 @@ tags:
pagination_next: cloud/getting-started/cloud-fundamentals
---

# Welcome to the Strapi Cloud Docs!
# Welcome to the Strapi Cloud Documentation!

<SubtleCallout title="Developer Docs, User Guide, and Strapi Cloud documentation" emoji="📍">
<!--
<SubtleCallout title="Strapi Cloud & Strapi CMS docs" emoji="📍">

The documentation for Strapi contains 3 main sections, accessible from the top navigation bar:
There are 2 Strapi documentations, one for each Strapi product:

- 🧑‍💻 The **[Developer Docs](/dev-docs/intro)** contain all the technical information related to the setup, advanced usage, customization, and update of your Strapi 5 application.
- 🧑‍🏫 The **[User Guide](/user-docs/intro)** is all about using Strapi's admin panel.
- ☁️ The **Strapi Cloud** documentation that you're currently reading is about deploying your Strapi application to Strapi Cloud and managing your Strapi Cloud projects and settings.
- <Icon name="cloud" /> The **Cloud documentation**, that you're currently reading, which is about deploying your Strapi application to Strapi Cloud and managing your Strapi Cloud projects and settings.
- <Icon name="feather" /> The **[CMS documentation](/dev-docs/intro)** contains all the information related to the admin panel as well as all the technical information related to the setup, advanced usage, customization and update of your Strapi 5 application.

</SubtleCallout>
-->

This documentation contains all technical documentation related to the setup, deployment, update and customization of your Strapi Cloud account and applications.
The Strapi Cloud documentation contains all information related to the setup, deployment, update and customization of your Strapi Cloud account and applications.

## What is Strapi Cloud

[Strapi Cloud](https://strapi.io/cloud) is a hosting platform that allows you to deploy your Strapi applications in a matter of minutes. It is a fully managed content platform built on top of Strapi, the leading open-source headless CMS.

Strapi Cloud enables you to increase your content velocity without having to compromise on customization needs and requirements. Development teams can rely on Strapi Cloud to abstract away the complexity of infrastructure management while keeping your development workflow and extending the core capabilities of Strapi. Content managers can use Strapi Cloud to autonomously manage all types of content and benefit from a complete set of content collaboration, security, and compliance features.

## What you will find here
:::strapi What is Strapi Cloud?
[Strapi Cloud](https://strapi.io/cloud) is a hosting platform that allows you to deploy your Strapi applications. It is a fully managed content platform <Annotation>**🤝 Why Strapi Cloud?**<br />Strapi Cloud enables you to increase your content velocity without having to compromise on customization needs and requirements. <br /> Development teams can rely on Strapi Cloud to abstract away the complexity of infrastructure management while keeping your development workflow and extending the core capabilities of Strapi. <br /> Content managers can use Strapi Cloud to autonomously manage all types of content and benefit from a complete set of content collaboration, security, and compliance features.</Annotation> built on top of Strapi, the open-source headless CMS.
:::

:::prerequisites
The typical workflow, which is recommended by the Strapi team, is:
Expand All @@ -41,7 +38,7 @@ The typical workflow, which is recommended by the Strapi team, is:
4. Deploy the application with Strapi Cloud.
:::

The Strapi Cloud documentation that you are currently reading is organised in topics in a order that should correspond to your journey with the product. The following cards, on which you can click, will redirect you to the main topics and steps of your Strapi Cloud journey.
The Strapi Cloud documentation is organised in topics in a order that should correspond to your journey with the product. The following cards, on which you can click, will redirect you to the main topics and steps.

<CustomDocCardsWrapper>
<CustomDocCard emoji="☁️" title="Project creation" description="Step-by-step guide to guide you through the creation and deployment of a Strapi Cloud project." link="/cloud/getting-started/deployment" />
Expand Down
68 changes: 38 additions & 30 deletions docusaurus/docs/dev-docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: 'Introduction'
description: The Strapi Dev Docs contain all the technical information related to the setup, advanced usage, customization, and update of your Strapi 5 application.
description: The Strapi CMS documentation contains all the admin panel related information and the technical information related to the setup, advanced usage, customization, and update of your Strapi 5 application.
displayed_sidebar: cmsSidebar
slug: /dev-docs/intro
pagination_next: dev-docs/setup-deployment
Expand All @@ -10,60 +10,68 @@ tags:
- concepts
---

# Welcome to the Strapi Developer Docs!
# Welcome to the Strapi CMS Documentation!

<SubtleCallout title="Developer Docs, User Guide, and Strapi Cloud documentation" emoji="📍">
<!--
<SubtleCallout title="Strapi CMS & Strapi Cloud docs" emoji="📍">

The documentation for Strapi contains 3 main sections, accessible from the top navigation bar:
There are 2 Strapi documentations, one for each Strapi product:

- 🧑‍💻 The **Developer Docs** that you're currently reading contain all the technical information related to the setup, advanced usage, customization, and update of your Strapi 5 application.
- 🧑‍🏫 The **[User Guide](/user-docs/intro)** is all about using Strapi's admin panel.
- ☁️ The **[Strapi Cloud](/cloud/intro)** documentation is about deploying your Strapi application to Strapi Cloud and managing your Strapi Cloud projects and settings.
- <Icon name="feather" /> The **CMS documentation**, that you're currently reading, which contains all the information related to a Strapi 5 project (installation, setup, deployment, content management in admin panel, etc).
- <Icon name="cloud" /> The **[Cloud documentation](/cloud/intro)**, which is about deploying your Strapi application to Strapi Cloud and managing your Strapi Cloud projects and settings.

</SubtleCallout>
-->

👉 If you're totally new to **Strapi** <Annotation>**💡 Did you know?**<br />The original purpose of the project was to help Boot**strap** your **API**: that's where the Strapi name comes from and how Strapi was created.<br /><br />Now, Strapi is an **open-source headless CMS** that gives developers the freedom to choose their favorite tools and frameworks and allows editors to manage and distribute their content using their application's admin panel.<br /><br />Based on a plugin system, Strapi is a flexible CMS whose admin panel and API are extensible — and which every part is customizable to match any use case. Strapi also has a built-in user system to manage in detail what the administrators and end users have access to.<br /></Annotation> or if you're a developer who would like to take the most out of Strapi, the Developer Docs are the place to start! We suggest you to:
The Strapi CMS documentation focuses on Strapi 5 and will take you through the complete journey of your Strapi 5 project. From the technical information related to the setup, advanced usage, customization and update of your project, to the management of the admin panel and its content and users.

1. Head over to the [Quick Start](/dev-docs/quick-start) guide.
2. Continue your journey through the various Developer Docs sections. The ["What you will learn"](#what-you-will-find-here) section gives you an overview of the available topics.

:::strapi What's new in Strapi 5?
Head over to the ["What's new in Strapi 5 docs?"](/dev-docs/whats-new) page for a quick tour.
:::

## What you will find here
<ThemedImage
alt="Homepage of the Admin Panel"
sources={{
light: '/img/assets/getting-started/admin-panel-homepage.png',
dark: '/img/assets/getting-started/admin-panel-homepage_DARK.png',
}}
/>

:::prerequisites
Strapi Developer Docs are mostly intended to developers and assumes some prior knowledge of the JavaScript ecosystem.
:::strapi Where to start as a beginner?
If you're totally new to **Strapi** <Annotation>**💡 Did you know?**<br />The original purpose of the project was to help Boot**strap** your **API**: that's where the Strapi name comes from and how Strapi was created.<br /><br />Now, Strapi is an **open-source headless CMS** that gives developers the freedom to choose their favorite tools and frameworks and allows editors to manage and distribute their content using their application's admin panel.<br /><br />Based on a plugin system, Strapi is a flexible CMS whose admin panel and API are extensible — and which every part is customizable to match any use case. Strapi also has a built-in user system to manage in detail what the administrators and end users have access to.<br /></Annotation>, we suggest you to:

If you also make your first steps with JavaScript web development while discovering Strapi, we encourage you to read more about [JavaScript](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics) and [npm](https://docs.npmjs.com/about-npm). If applicable to your project, you can also learn about [TypeScript](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html) before diving deeper into the Strapi Developer Docs.
1. Head over to the [Quick Start](/dev-docs/quick-start) guide.
2. Learn about the Admin Panel and the 2 main parts of the Strapi CMS: the Content Manager and Content-type Builder.
3. Go through the available Strapi features, each fully documented in their own page. Perhaps you could be interested by Draft & Publish, Internationalization or Static Preview?
:::

The table of content of the Strapi Developer Docs displays 7 main sections in an order that should correspond to your journey with the product, from the very first steps to the most advanced aspects of Strapi's usage.
The table of content of the Strapi CMS documentation displays 7 main sections in an order that should correspond to your journey with the product. Click on the cards to be redirected to the introduction of the section, or to the most read page of that section.


Clicking on any of the following cards will direct you to the introduction page for the category, with additional details and concepts:

<CustomDocCardsWrapper>

<CustomDocCard icon="rocket" title="Getting Started" description="The section you're reading right now. Read recommended information for Strapi beginners." link="#" />
<CustomDocCard icon="rocket" title="Getting Started" description="Install and deploy Strapi, then start using the admin panel. Recommended read for beginners!" link="/dev-docs/installation" />

<CustomDocCard title="Setup & Deployment" description="Install, configure, and deploy Strapi." link="/dev-docs/setup-deployment" />
<CustomDocCard icon="backpack" title="Features" description="Learn about the Strapi features, and how to configure and use them." link="" />

<CustomDocCard title="APIs" description="Query your content with REST, GraphQL, and Strapi's lower-level APIs." link="/dev-docs/api/content-api" />
<CustomDocCard icon="cube" title="APIs" description="Query your content with REST, GraphQL, and Strapi's lower-level APIs." link="/dev-docs/api/content-api" />

<CustomDocCard title="Advanced features" description="Use built-in Strapi features for advanced use cases." link="/dev-docs/advanced-features" />
<CustomDocCard icon="gear-fine" title="Configurations" description="Follow the instructions to handle the base and additional configurations for your project." link="/dev-docs/configurations" />

<CustomDocCard title="Customization" description="Customize the Strapi server and admin panel." link="/dev-docs/customization" />
<CustomDocCard icon="laptop" title="Development" description="Customize the Strapi server and admin panel. Learn about the most advanced options for your project." link="/dev-docs/customization" />

<CustomDocCard title="Plugins" description="Use Strapi built-in plugins or develop your own plugins." link="/dev-docs/plugins" />
<CustomDocCard icon="puzzle-piece" title="Plugins" description="Use Strapi built-in plugins or develop your own plugins." link="" />

<CustomDocCard title="Upgrade" description="Upgrade your application to the most recent Strapi versions." link="/dev-docs/upgrades" />
<CustomDocCard icon="escalator-up" title="Upgrade" description="Upgrade your application to the most recent Strapi versions." link="/dev-docs/migration/v4-to-v5/introduction-and-faq" />

</CustomDocCardsWrapper>

:::tip Tips
- If you already know exactly what you're searching for, use the search bar at the top or navigate using the table of content.
:::tip Tips to make the best of the docs
- If you already know exactly what you're searching for, use the search bar or navigate using the table of content.
- If you prefer learning more about Strapi while looking at the project code structure, you can use the interactive [project structure](/dev-docs/project-structure) page.
- If demos are more your thing, feel free to watch the [video demo](https://youtu.be/zd0_S_FPzKg), or you can request a [live demo](https://strapi.io/demo).
- Try our AI assistant: Click or tap the **Ask AI** button and ask your questions using natural language. Watch it answer you in real time, then read recommended sources for more details.
:::

:::strapi Information for beginner developers
Some parts of the CMS documentation (e.g. APIs, Configuration, Development) are mostly intended to developers and assume some prior knowledge of the JavaScript ecosystem.

If you also make your first steps with JavaScript web development while discovering Strapi, we encourage you to read more about [JavaScript](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics) and [npm](https://docs.npmjs.com/about-npm). If applicable to your project, you can also learn about [TypeScript](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html) before diving deeper into these technical parts of the CMS documentation.
:::
28 changes: 26 additions & 2 deletions docusaurus/docs/user-docs/features/RBAC.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,14 @@ On the top right side of the *Administration panel > Roles* interface, an **Add
To create a new role, click on the **Add new role** button.
Clicking on the **Add new role** button will redirect you to the roles edition interface, where you will be able to edit the role's details and configure its permissions (see [Editing a role](#editing-roles-details)).

<ThemedImage
alt="New role with RBAC"
sources={{
light: '/img/assets/users-permissions/new-role.png',
dark: '/img/assets/users-permissions/new-role_DARK.png',
}}
/>

:::tip
In the *Roles* interface, from the table, you can click on the duplicate button ![Duplicate icon](/img/assets/icons/v5/Duplicate.svg) to create a new role by duplicating an existing one.
:::
Expand Down Expand Up @@ -205,13 +213,21 @@ Custom conditions can only be set for permissions that have been ticked to be gr

The *Users* sub-section of *Administration panel* displays a table listing all the administrators of your Strapi application.

<ThemedImage
alt="Users interface"
sources={{
light: '/img/assets/users-permissions/usage-interface.png',
dark: '/img/assets/users-permissions/usage-interface_DARK.png',
}}
/>

From this interface, it is possible to:

- make a textual search <ScreenshotNumberReference number="1" /> to find specific administrators,
- set filters <ScreenshotNumberReference number="2" /> to find specific administrators,
- create a new administrator account (see [Creating a new account](#creating-a-new-account)) <ScreenshotNumberReference number="3" />,
- delete an administrator account (see [Deleting an account](#deleting-an-account)),
- or access information regarding an administrator account, and edit it (see [Editing an account](#editing-an-account)).
- delete an administrator account <ScreenshotNumberReference number="4" /> (see [Deleting an account](#deleting-an-account)),
- or access information regarding an administrator account, and edit it <ScreenshotNumberReference number="5" /> (see [Editing an account](#editing-an-account)).

For each administrator listed in the table, their main account information are displayed, including name, email and attributed role. The status of their account is also indicated: active or inactive, depending on whether the administrator has already logged in to activate the account or not.

Expand Down Expand Up @@ -249,6 +265,14 @@ To create a new administrator account:
The administrator invitation URL is accessible from the administrator's account until it has been activated.
:::

<ThemedImage
alt="User invitation"
sources={{
light: '/img/assets/users-permissions/invite-new-user.png',
dark: '/img/assets/users-permissions/invite-new-user_DARK.png',
}}
/>

### Deleting an account

Administrator accounts can be deleted from the *Administration panel > Users* interface. It is possible to delete one or several administrator accounts at the same time.
Expand Down
12 changes: 12 additions & 0 deletions docusaurus/docs/user-docs/features/admin-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ sources={{

## Overview

:::prerequisites
There are a few factors that you should keep in mind when using the admin panel, as they could modify the interface and your experience with it.

- **Development, Staging or Production Environment** <br/> Your content structure and application configuration change status: from development environment to production or staging environment once deployed. Some features are only available in development. Check the Identity Cards to know when features are usable.

- **License and Pricing Plans** <br/> Some features's availability or limits depend on whether your application is using the free Community Edition, the [Growth plan](https://strapi.io/pricing-self-hosted), or the [Enterprise plan](https://strapi.io/pricing-self-hosted). Look for the <GrowthBadge /> and <EnterpriseBadge /> badges in the docs.

- **Roles and Permissions** <br/> Some features and the content itself are ruled by a system of permissions that can be defined at a detailed level. Depending on your role and permissions, you may not be able to access all the features and options. Read the RBAC feature documentation for more information.

- **Future flags** <br/> Some incoming Strapi features are not yet ready to be shipped to all users, but Strapi still offers community users the opportunity to provide early feedback. These experimental features require enabling the corresponding future flags. Look for the <FeatureFlagBadge /> badge in the docs and read the [Features](/dev-docs/configurations/features#enabling-a-future-flag) documentation for more information.
:::

<Guideflow lightId="dkd2m1lsgr" darkId="dkd2mjlugr"/>

## Configuration
Expand Down
8 changes: 7 additions & 1 deletion docusaurus/docs/user-docs/features/content-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,10 @@ To restore a version:
If the [Internationalization (i18n)](/user-docs/content-manager/translating-content) feature is enabled for the content-type, restoring a version with a unique field (i.e. a field whose content is the same for all locales) will restore the content of this field for all locales.
:::

<!-- Add illustration here -->
<ThemedImage
alt="Restoring version with Content History"
sources={{
light:'/img/assets/content-manager/restoring-content-history.png',
dark:'/img/assets/content-manager/restoring-content-history_DARK.png',
}}
/>
Loading