Skip to content

Commit e2db733

Browse files
authored
Add callout to gather feedback for all backend custom. pages (#1661)
1 parent 363aba4 commit e2db733

File tree

10 files changed

+39
-4
lines changed

10 files changed

+39
-4
lines changed

docusaurus/docs/dev-docs/backend-customization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ description: All elements of Strapi's back end, like routes, policies, middlewar
44

55
---
66

7+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
8+
79
# Back-end customization
810

9-
Strapi runs an HTTP server based on [Koa](https://koajs.com/), a back end JavaScript framework.
11+
<FeedbackCallout components={props.components}/>
1012

11-
:::strapi What is Koa?
12-
If you are not familiar with the Koa back end framework, we highly recommend you to read the [Koa's documentation introduction](http://koajs.com/#introduction).
13-
:::
13+
Strapi runs an HTTP server based on [Koa](https://koajs.com/), a back end JavaScript framework. If you are not familiar with the Koa back end framework, we highly recommend you to read the [Koa's documentation introduction](http://koajs.com/#introduction).
1414

1515
Each part of Strapi's back end can be customized:
1616

docusaurus/docs/dev-docs/backend-customization/controllers.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
2+
13
# Controllers
24

5+
<FeedbackCallout components={props.components}/>
6+
37
Controllers are JavaScript files that contain a set of methods, called actions, reached by the client according to the requested [route](/dev-docs/backend-customization/routes). Whenever a client requests the route, the action performs the business logic code and sends back the [response](/dev-docs/backend-customization/requests-responses). Controllers represent the C in the model-view-controller (MVC) pattern.
48

59
In most cases, the controllers will contain the bulk of a project's business logic. But as a controller's logic becomes more and more complicated, it's a good practice to use [services](/dev-docs/backend-customization/services) to organize the code into re-usable parts.

docusaurus/docs/dev-docs/backend-customization/middlewares.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22
title: Middlewares
33
---
44

5+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
6+
57
# Middlewares customization
68

9+
<FeedbackCallout components={props.components}/>
10+
711
:::strapi Different types of middlewares
812

913
In Strapi, 2 middleware concepts coexist:

docusaurus/docs/dev-docs/backend-customization/models.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,12 @@ sidebarDepth: 3
2525

2626
---
2727

28+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
29+
2830
# Models
2931

32+
<FeedbackCallout components={props.components}/>
33+
3034
As Strapi is a headless Content Management System (CMS), creating a data structure for the content is one of the most important aspects of using the software. Models define a representation of the data structure.
3135

3236
There are 2 different types of models in Strapi:

docusaurus/docs/dev-docs/backend-customization/policies.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ displayed_sidebar: devDocsSidebar
55

66
---
77

8+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
9+
810
# Policies
911

12+
<FeedbackCallout components={props.components}/>
13+
1014
Policies are functions that execute specific logic on each request before it reaches the [controller](/dev-docs/backend-customization/controllers). They are mostly used for securing business logic.
1115

1216
Each [route](/dev-docs/backend-customization/routes) of a Strapi project can be associated to an array of policies. For example, a policy named `is-admin` could check that the request is sent by an admin user, and restrict access to critical routes.

docusaurus/docs/dev-docs/backend-customization/requests-responses.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@ description: Learn more about requests and responses for Strapi, the most popula
44

55
---
66

7+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
8+
79
# Requests & Responses
810

11+
<FeedbackCallout components={props.components}/>
12+
913
## Requests
1014

1115
The context object (`ctx`) contains all the requests related information. They are accessible through `ctx.request`, from [controllers](/dev-docs/backend-customization/controllers.md) and [policies](/dev-docs/backend-customization/policies.md).

docusaurus/docs/dev-docs/backend-customization/routes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@ description: Strapi routes handle requests to your content and are auto-generate
44
displayed_sidebar: devDocsSidebar
55
---
66

7+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
8+
79
# Routes
810

11+
<FeedbackCallout components={props.components}/>
12+
913
Requests sent to Strapi on any URL are handled by routes. By default, Strapi generates routes for all the content-types (see [REST API documentation](/dev-docs/api/rest)). Routes can be [added](#implementation) and configured:
1014

1115
- with [policies](#policies), which are a way to block access to a route,

docusaurus/docs/dev-docs/backend-customization/services.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ displayed_sidebar: devDocsSidebar
55

66
---
77

8+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
9+
810
# Services
911

12+
<FeedbackCallout components={props.components}/>
13+
1014
Services are a set of reusable functions. They are particularly useful to respect the "don’t repeat yourself" (DRY) programming concept and to simplify [controllers](/dev-docs/backend-customization/controllers.md) logic.
1115

1216
## Implementation

docusaurus/docs/dev-docs/backend-customization/webhooks.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ description: Strapi webhooks are user-defined HTTP callbacks used by an applicat
55

66
---
77

8+
import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'
9+
810
# Webhooks
911

12+
<FeedbackCallout components={props.components}/>
13+
1014
Webhook is a construct used by an application to notify other applications that an event occurred. More precisely, webhook is a user-defined HTTP callback. Using a webhook is a good way to tell third party providers to start some processing (CI, build, deployment ...).
1115

1216
The way a webhook works is by delivering information to a receiving application through HTTP requests (typically POST requests).
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
:::callout 💬 Strapi team needs you to improve this documentation!
2+
We are currently reworking the Backend Customization section of the Strapi documentation. If you would like to help, please feel free to fill in [this form](https://forms.gle/YS8zGUrG6FQ72dmh8) to share with us your opinions, needs and requests.
3+
:::

0 commit comments

Comments
 (0)