Skip to content

Commit ea49c8a

Browse files
Add new "TL;DR" component anywhere relevant (#2702) (#2706)
* Add TL;DR in quote at the beginning of each Cloud docs page * Add first draft of Tldr component with a very basic design * Create some Tldr example content in Preview feature page * Test different design variants * Try various design proposals * Add TL;DRs in most files of the CMS docs * Test simple design * Streamline Tldr component design * Use component in all pages where a tl;dr content was added * Add missing TL;DRs and fix a few mistakes --------- Co-authored-by: Mégane Lacheny <[email protected]>
1 parent cb57976 commit ea49c8a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+692
-356
lines changed

docusaurus/docs/cloud/account/account-billing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ tags:
1414

1515
import InvoiceStatus from '/docs/snippets/invoices-statuses.md'
1616

17-
# Account billing & invoices
17+
# Account billing & invoices
18+
19+
<Tldr>
20+
Billing details and invoices are managed on the Profile page, where payment methods are updated and invoice history is available.
21+
</Tldr>
1822

1923
Through the *Profile* page, accessible by clicking on your profile picture on the top right hand corner of the interface then clicking on **Profile**, you can access the [<Icon name="credit-card" /> *Billing*](#account-billing) and [<Icon name="invoice" /> *Invoices*](#account-invoices) tabs.
2024

docusaurus/docs/cloud/account/account-settings.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ pagination_next: cloud/account/account-billing
1515

1616
# Profile settings
1717

18+
<Tldr>
19+
Settings of the Profile page include account details, connected accounts, and account deletion options.
20+
</Tldr>
21+
1822
The *Profile* page enables you to manage your account details and preferences. It is accessible by clicking on your profile picture, on the top right hand corner of the interface, and **Profile**.
1923

2024
There are 3 tabs available in the *Profile* interface: <Icon name="faders" /> [*General*](#general), <Icon name="credit-card" /> *Billing* and <Icon name="invoice" /> Invoices (the last 2 are documented in the [Account billing details](/cloud/account/account-billing) section of this documentation).

docusaurus/docs/cloud/advanced/database.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ pagination_next: cloud/advanced/email
1515

1616
# Database
1717

18+
<Tldr>
19+
Default PostgreSQL can be swapped for any supported SQL database by aligning configuration and environment variables.
20+
</Tldr>
21+
1822
Strapi Cloud provides a pre-configured PostgreSQL database by default. However, you can also configure it to utilize an external SQL database, if needed.
1923

2024
:::prerequisites

docusaurus/docs/cloud/advanced/email.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ tags:
1414

1515
# Email Provider
1616

17+
<Tldr>
18+
Third‑party email services integrate through plugins and environment variables to replace the default sender.
19+
</Tldr>
20+
1721
Strapi Cloud comes with a basic email provider out of the box. However, it can also be configured to utilize another email provider, if needed.
1822

1923
:::caution

docusaurus/docs/cloud/advanced/upload.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ tags:
1616

1717
# Upload Provider
1818

19+
<Tldr>
20+
External storage like S3 or Cloudinary requires plugin setup, security middleware, and Cloud variables.
21+
</Tldr>
22+
1923
Strapi Cloud comes with a local upload provider out of the box. However, it can also be configured to utilize a third-party upload provider, if needed.
2024

2125
:::caution

docusaurus/docs/cloud/cli/cloud-cli.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ tags:
99
pagination_next: cloud/advanced/database
1010
---
1111

12-
# Command Line Interface (CLI) <NewBadge />
12+
# Command Line Interface (CLI)
13+
14+
<Tldr>
15+
CLI commands handle login, project deploy, linking, listing, and logout without needing a remote repository.
16+
</Tldr>
1317

1418
Strapi Cloud comes with a Command Line Interface (CLI) which allows you to log in and out, and to deploy a local project without it having to be hosted on a remote git repository. The CLI works with both the `yarn` and `npm` package managers.
1519

docusaurus/docs/cloud/getting-started/caching.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ tags:
1010

1111
# Caching & Performance
1212

13+
<Tldr>
14+
Edge caching via Cache-Control headers reduces latency and server load for heavy static content.
15+
</Tldr>
16+
1317
For Strapi Cloud applications with large amounts of cacheable content, such as images, videos, and other static assets, enabling CDN (Content Delivery Network) caching via the <ExternalLink to="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control" text="`Cache-control` header"/> can help improve application performance.
1418

1519
CDN caching can help improve application performance in a few ways:

docusaurus/docs/cloud/projects/collaboration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ tags:
1212

1313
# Collaboration on projects
1414

15+
<Tldr>
16+
Project owners invite maintainers through the Share button, manage pending invitations, and revoke access.
17+
</Tldr>
1518

1619
Projects are created by a user via their Strapi Cloud account. Strapi Cloud users can share their projects to anyone else, so these new users can have access to the project dashboard and collaborate on that project, without the project owner to ever have to share their credentials.
1720

docusaurus/docs/cloud/projects/deploys-history.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ tags:
1414

1515
# Deployment history and logs {#deploy-history-and-logs}
1616

17+
<Tldr>
18+
Deployments tab lists every build with status and allows deep inspection of build and runtime logs.
19+
</Tldr>
20+
1721
For each Strapi Cloud project, you can access the history of all deployments that occurred and their details including build and deployment logs. This information is available in the *Deployments* tab.
1822

1923
## Viewing the deployment history {#viewing-deploy-history}

docusaurus/docs/cloud/projects/deploys.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ pagination_next: cloud/projects/deploys-history
1515

1616
# Deployments management
1717

18+
<Tldr>
19+
Deployment triggers can be manual or automatic on git pushes, with the ability to cancel active builds from dashboard or CLI.
20+
</Tldr>
21+
1822
The creation of a new Strapi Cloud project automatically trigger the deployment of that project. After that, deployments can be:
1923

2024
- manually triggered whenever needed, [from the Cloud dashboard](#triggering-a-new-deployment) or [from the CLI](/cloud/cli/cloud-cli#strapi-deploy),

0 commit comments

Comments
 (0)