Skip to content

Commit 54fa167

Browse files
committed
feat: mark experimental features as such
1 parent 6b3219f commit 54fa167

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

src/Web/Documentation/content/main/1-essentials/05-database.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
---
22
title: Database
3+
keywords: "Experimental"
34
---
45

6+
:::warning
7+
The ORM implementation of Tempest is currently experimental. Although you can use it, please note that it is not covered by our backwards compatibility promise.
8+
:::
9+
10+
## Overview
11+
512
In contrast to many popular ORMs, Tempest models aren't required to be tied to the database. A model's persisted data can be loaded from any kind of data source: an external API, JSON, Redis, XML, … In essence, a model is nothing more than a class with public typed properties and methods. Tempest will use a model class' type information to determine how data should be mapped between objects.
613

714
In other words, a model can be as simple as this class:

src/Web/Documentation/content/main/2-tempest-in-depth/03-auth.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
---
22
title: Authentication and authorization
3+
keywords: "Experimental"
34
---
45

6+
## Overview
7+
8+
:::warning
9+
The authentication and authorization implementations of Tempest are currently experimental. Although you can use them, please note that they are not covered by our backwards compatibility promise.
10+
:::
11+
512
Logging in (authentication )and verifying whether a user is allowed to perform a specific action (authorization) are two crucial parts of any web application. Tempest comes with a built-in authenticator and authorizer, as well as a base `User` and `Permission` model (if you want to).
613

714
## Authentication

src/Web/Documentation/content/main/2-tempest-in-depth/08-commands.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Command bus
3+
keywords: "Experimental"
34
---
45

56
Tempest comes with a built-in command bus, which can be used to dispatch a command to its handler (synchronous or asynchronous). A command bus offers multiple advantages over a more direct approach to modelling processes: commands and their handlers can easily be tested in isolation, they are simple to serialize, and similar to the eventbus, the command bus also supports middleware.
@@ -78,6 +79,10 @@ final readonly class UserController()
7879

7980
## Async commands
8081

82+
:::warning
83+
The asynchronous commands implementation of Tempest is currently experimental. Although you can use it, please note that it is not covered by our backwards compatibility promise.
84+
:::
85+
8186
A common use case for Tempest's command bus is to dispatch asynchronous commands: commands that are executed by their handler in the background, outside the main PHP process. Making a command asynchronous is done by adding the `#[AsyncCommand]` to your command object:
8287

8388
```php

0 commit comments

Comments
 (0)