Skip to content

Commit

Permalink
Merge branch 'main' of github.com:strapi/documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pwizla committed Dec 11, 2024
2 parents 340b49e + dcab28d commit c874104
Show file tree
Hide file tree
Showing 17 changed files with 39 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Before going any further into this Strapi Cloud documentation, we recommend you

- **Strapi Cloud Pricing Plans** <br/> As a Strapi Cloud user you have the choice between 3 tiers: Developer, Pro and Team. Depending on the tier, you have access to different functionalities, support and customization options (see [Pricing page](https://strapi.io/pricing-cloud) for more details). In this Strapi Cloud documentation, the <CloudDevBadge />, <CloudProBadge />, and <CloudTeamBadge /> badges can be displayed beside a section's title to indicate for which tier the feature is available.

- **Strapi CMS Enterprise features** <br/> Some of Strapi features, usually accessible via the Enterprise Edition of Strapi CMS, are included in some Strapi Cloud tiers (see [Pricing page](https://strapi.io/pricing-cloud) and [Information on billing & usage](/cloud/getting-started/usage-billing) for more details). These features, highlighted with an <EnterpriseBadge /> badge, are documented in the [User Guide](https://docs.strapi.io/user-docs/intro) and the [Developer Documentation](https://docs.strapi.io/dev-docs/intro).
- **Strapi CMS features** <br/> The Strapi Cloud plans include some Strapi CMS features (see [Pricing page](https://strapi.io/pricing-cloud) for more details). These features, highlighted with a <GrowthBadge /> or an <EnterpriseBadge /> badge, are documented in the [User Guide](https://docs.strapi.io/user-docs/intro) and the [Developer Documentation](https://docs.strapi.io/dev-docs/intro).

- **Types of Strapi Cloud users** <br/> There can be 2 types of users on a Strapi Cloud project: owners and maintainers. The owner is the one who has created the project and has therefore access to all features and options for the project. Maintainers are users who have been invited to contribute to an already created project by its owner. Maintainers, as documented in the [Collaboration](/cloud/projects/collaboration) page, cannot view and access all features and options from the Strapi Cloud dashboard.

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/cloud/projects/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ Resetting an environment deletes all environments data and resets the variables
2. Write in the textbox your *Environment name*.
3. Click on the **Delete environment** button to confirm the deletion.

### Backups <CloudProBadge /> <CloudTeamBadge /> <UpdatedBadge /> {#backups}
### Backups <CloudProBadge /> <CloudTeamBadge /> {#backups}

The ![Backups icon](/img/assets/icons/ArrowClockwise.svg) *Backups* tab informs you of the status and date of the latest backup of your Strapi Cloud projects. The databases associated with all existing Strapi Cloud projects are indeed automatically backed up (weekly for Pro plans and daily for Team plans). Backups are retained for a 28-day period. Additionally, you can create a single manual backup.

Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/dev-docs/backend-customization/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ By default Strapi webhooks can be triggered by the following events:
| [`media.update`](#mediaupdate) | Triggered when a media is updated. |
| [`media.delete`](#mediadelete) | Triggered when a media is deleted. |
| [`review-workflows.updateEntryStage`](#review-workflowsupdateentrystage) | Triggered when content is moved between review stages (see [review workflows](/user-docs/settings/review-workflows)).<br />This event is only available with the <EnterpriseBadge /> edition of Strapi. |
| [`releases.publish`](#releasespublish-) | Triggered when a Release is published (see [Releases](/user-docs/releases/introduction)).<br />This event is only available with the <EnterpriseBadge /> edition of Strapi and the <CloudTeamBadge /> plan for Strapi Cloud. |
| [`releases.publish`](#releasespublish-) | Triggered when a Release is published (see [Releases](/user-docs/releases/introduction)).<br />This event is available with the <GrowthBadge /> or the <EnterpriseBadge /> plan of Strapi and the <CloudTeamBadge /> plan for Strapi Cloud. |

\*only when `draftAndPublish` is enabled on this Content Type.

Expand Down Expand Up @@ -471,7 +471,7 @@ This event is only available with the <EnterpriseBadge/> edition of Strapi.<br /
}
```

### `releases.publish` <EnterpriseBadge/><CloudTeamBadge/>
### `releases.publish` <GrowthBadge /><EnterpriseBadge/><CloudTeamBadge/>

The event is triggered when a [release](/user-docs/releases/introduction) is published.

Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/dev-docs/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ You can join [GitHub](https://github.com/strapi/strapi), the [Forum](https://for

## Support

Strapi is offered as free and open-source for users who wish to self-host the software. When having an issue or a question, the [forum](https://forum.strapi.io) is great first place to reach out for help. Both the Strapi community and core developers often check this platform and answer posts.
Strapi's Community plan is a free and open-source option for users who wish to self-host the software. If you have an issue or a question, the [forum](https://forum.strapi.io) is great first place to reach out for help. Both the Strapi community and core developers often check this platform and answer posts.

For enterprise support, please see our [Enterprise Support platform](https://support.strapi.io/support/home). Please note that you will need to have an active <EnterpriseBadge /> license to place tickets.
For customers on our paid plans, you can reference our [Support platform](https://support.strapi.io/support/home) to determine your support level and check out our Support platform for more information. Please note that you must have an active <GrowthBadge /> or <EnterpriseBadge /> plan to submit a ticket.
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ A similar result can be achieved in Strapi v4 by adding the `lockIcon` property.

### Manual migration

If your custom Strapi v4 code uses the `lockIcon` property to highlight a paid feature that requires an <EnterpriseBadge /> license, search and replace `lockIcon: true` by `licenseOnly: true`.
If your custom Strapi v4 code uses the `lockIcon` property to highlight a paid feature that requires a <GrowthBadge /> or an <EnterpriseBadge /> plan, search and replace `lockIcon: true` by `licenseOnly: true`.
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ description: Instructions to include content in a release
displayed_sidebar: userDocsSidebar
tags:
- admin panel
- Growth feature
- Enterprise feature
- releases feature
- Strapi Cloud
---

# Including content in a release <EnterpriseBadge /> <CloudTeamBadge />
# Including content in a release <GrowthBadge /> <EnterpriseBadge /> <CloudTeamBadge />

Using the [Releases](/user-docs/releases/introduction) feature, you can group several entries to publish them altogether. Adding entries to a release is done from the Content Manager. You can also remove an entry from a release while updating the entry.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- Content History
---

# Content History <EnterpriseBadge/> <CloudProBadge/> <CloudTeamBadge/> <NewBadge />
# Content History <GrowthBadge /> <EnterpriseBadge/> <CloudProBadge/> <CloudTeamBadge/> <NewBadge />

The Content History feature of the Content Manager gives you the ability to browse and restore previous versions of documents created with the Content Manager.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Before going any further into this user guide, we recommend you to acknowledge t

- **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. However, we always keep live both the documentation of the current Strapi version, and the documentation of the previous major version — the latter being officially and actively maintained for up to 12 months after the release of the newest Strapi version.

- **License and Pricing Plans** <br/> As a Strapi user you have the choice between using the Community Edition, which is entirely free, or the [Enterprise Edition](https://strapi.io/pricing-self-hosted). In this user guide, if a feature is only available for the Enterprise Edition, an <EnterpriseBadge /> badge is displayed beside the section's title. Strapi can also be hosted on Strapi Cloud by subscribing to a tier that meets the functionality, support, and customization options specified on [Strapi Cloud](https://strapi.io/pricing-cloud). In this user guide, the <CloudDevBadge />, <CloudProBadge />, and <CloudTeamBadge /> badges can be displayed beside a section's title to indicate the feature is available on the tier.
- **License and Pricing Plans** <br/> As a Strapi user you have the choice between using the Community Edition, which is entirely free, the [Growth plan](https://strapi.io/pricing-self-hosted), or the [Enterprise plan](https://strapi.io/pricing-self-hosted). In this user guide, if a feature is available for the Growth plan, or for the Enterprise plan, then respectively a <GrowthBadge /> or an <EnterpriseBadge /> badge will be displayed beside the section's title. Strapi can also be hosted on Strapi Cloud by subscribing to a tier that meets the functionality, support, and customization options specified on [Strapi Cloud](https://strapi.io/pricing-cloud). In this user guide, the <CloudDevBadge />, <CloudProBadge />, and <CloudTeamBadge /> badges can be displayed beside a section's title to indicate the feature is available on the tier.

- **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 on these new features or changes. This feedback is invaluable in enhancing the feature before the final release. Such experimental features are indicated by a <FutureBadge /> badge throughout the documentation and enabling these features requires enabling the corresponding future flags (see [Developer Docs](/dev-docs/configurations/features#enabling-a-future-flag)).

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/user-docs/plugins/strapi-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Strapi builds and maintains plugins that extend the functionality of a core Stra
:::note

- Some Strapi Starters and Templates might install additional plugins beyond the default plugins listed below.
- If plugin options are only available with an [Enterprise edition license](https://strapi.io/pricing-self-hosted), they are marked with <EnterpriseBadge /> in this reference guide.
- If plugin options are only available with a [paid plan](https://strapi.io/pricing-self-hosted), they are marked with a <GrowthBadge /> or an <EnterpriseBadge /> badge in this reference guide.
- All plugin installations can be confirmed in ![Cog icon](/img/assets/icons/v5/Cog.svg) *Settings > Plugins* in the admin panel.

:::
Expand Down
3 changes: 2 additions & 1 deletion docusaurus/docs/user-docs/releases/creating-a-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ title: Creating a release
description: Instructions to create a release from the admin panel
tags:
- admin panel
- Growth feature
- Enterprise feature
- Releases feature
- Strapi Cloud
---

# Creating a release <EnterpriseBadge /> <CloudTeamBadge />
# Creating a release <GrowthBadge /> <EnterpriseBadge /> <CloudTeamBadge />

The ![Releases icon](/img/assets/icons/v5/PaperPlane.svg) [Releases](/user-docs/releases/introduction) page allows creating new releases that will be used to organize entries.

Expand Down
3 changes: 2 additions & 1 deletion docusaurus/docs/user-docs/releases/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ title: Introduction to Releases
description: Introduction to the Releases feature that enables content managers to organize entries to publish/unpublish simultaneously
tags:
- admin panel
- Growth feature
- Enterprise feature
- introduction
- Releases feature
- Strapi Cloud
pagination_next: user-docs/releases/creating-a-release
---

# Releases <EnterpriseBadge /> <CloudTeamBadge/>
# Releases <GrowthBadge /> <EnterpriseBadge /> <CloudTeamBadge/> <CloudTeamBadge/>

Releases enables content managers to organize entries into containers that can perform publish and unpublish actions simultaneously. A release can contain entries from different content types and can mix locales.

Expand Down
3 changes: 2 additions & 1 deletion docusaurus/docs/user-docs/releases/managing-a-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ title: Managing a release
description: Instructions on how to manage a Release from the admin panel
tags:
- admin panel
- Growth feature
- Enterprise feature
- Releases feature
- Strapi Cloud
---

# Managing a release <EnterpriseBadge /> <CloudTeamBadge />
# Managing a release <GrowthBadge /> <EnterpriseBadge /> <CloudTeamBadge />

Adding entries to a [release](/user-docs/releases/introduction) allow viewing them altogether on a single page.

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "strapi-docs",
"version": "5.3.0",
"version": "5.4.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down
6 changes: 3 additions & 3 deletions docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ const sidebars = {
type: 'doc',
id: 'dev-docs/configurations/database',
customProps: {
updated: true,
updated: false,
}
},
'dev-docs/configurations/server',
Expand Down Expand Up @@ -250,7 +250,7 @@ const sidebars = {
label: 'Status',
id: 'dev-docs/api/document-service/status',
customProps: {
updated: true,
updated: false,
}
},
{
Expand Down Expand Up @@ -308,7 +308,7 @@ const sidebars = {
type: 'doc',
id: 'dev-docs/typescript/development',
customProps: {
updated: true,
updated: false,
}
},
'dev-docs/typescript/adding-support-to-existing-project',
Expand Down
10 changes: 10 additions & 0 deletions docusaurus/src/components/Badge.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,16 @@ export function EnterpriseBadge(props) {
);
}

export function GrowthBadge(props) {
return (
<Badge
variant="Growth"
link="https://strapi.io/pricing-self-hosted"
{...props}
/>
);
}

export function CloudProBadge(props) {
return (
<Badge
Expand Down
5 changes: 5 additions & 0 deletions docusaurus/src/scss/badge.scss
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@
--custom-badge-color: rgb(229, 136, 41);
}

&--growth {
--custom-badge-background-color: var(--strapi-primary-600);
--custom-badge-color: white;
}

&--strapicloudpro {
--custom-badge-background-color: rgb(55, 34, 254);
--custom-badge-color: #fff;
Expand Down
3 changes: 2 additions & 1 deletion docusaurus/src/theme/MDXComponents.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import FeedbackPlaceholder from '../components/FeedbackPlaceholder';
import CustomDocCard from '../components/CustomDocCard';
import CustomDocCardsWrapper from '../components/CustomDocCardsWrapper';
import { InteractiveQueryBuilder } from '../components/InteractiveQueryBuilder/InteractiveQueryBuilder';
import { AlphaBadge, BetaBadge, FutureBadge, EnterpriseBadge, CloudDevBadge, CloudProBadge, CloudTeamBadge, NewBadge, UpdatedBadge } from '../components/Badge';
import { AlphaBadge, BetaBadge, FutureBadge, EnterpriseBadge, GrowthBadge, CloudDevBadge, CloudProBadge, CloudTeamBadge, NewBadge, UpdatedBadge } from '../components/Badge';
import { SideBySideColumn, SideBySideContainer } from '../components';
import ThemedImage from '@theme/ThemedImage';
import {
Expand Down Expand Up @@ -50,6 +50,7 @@ export default {
BetaBadge,
FutureBadge,
EnterpriseBadge,
GrowthBadge,
NewBadge,
UpdatedBadge,
CloudDevBadge,
Expand Down

0 comments on commit c874104

Please sign in to comment.