Skip to content

Commit cef50ff

Browse files
committed
add more info to automation actions
1 parent f14c12f commit cef50ff

File tree

6 files changed

+30
-7
lines changed

6 files changed

+30
-7
lines changed

src/app/layout.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ const RootLayout = ({
4747
</main>
4848
</div>
4949
</div>
50+
<hr className='mt-6 mb-6' />
5051
<footer className="text-small">
5152
forumify documentation&nbsp;
5253
<a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">CC BY 4.0</a>.

src/app/navigation.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
"path": "cms",
2525
"label": "CMS"
2626
},
27+
{
28+
"type": "route",
29+
"path": "automation",
30+
"label": "Automation"
31+
},
2732
{
2833
"type": "route",
2934
"path": "calendar",

src/app/user-manual/admin-panel/page.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ On the configuration page you can modify basic settings regarding your instance.
4545
- General: Basic information regarding your forum,
4646
- Users: Any settings related to user registration and forum profiles,
4747
- Spam Protection: reCAPTCHA settings.
48-
- Emails*: Configuration for your e-mail server.
48+
- Emails\*: Configuration for your e-mail server.
4949

50-
**Email settings are not available on forumify cloud.*
50+
*\*Email settings are not available on forumify cloud.*
5151

5252
### <UserList /> Users
5353

@@ -73,5 +73,5 @@ Here you can find:
7373
- <Link href="/user-manual/menu-builder">Menu Builder</Link>,
7474
- Plugins,
7575
- Reactions,
76-
- <link href="/user-manual/security">Roles</Link>,
76+
- <Link href="/user-manual/security">Roles</Link>,
7777
- Themes.

src/app/user-manual/automation/page.mdx

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ Each automation consists of 3 parts:
1919
If you are seeing any triggers, conditions or actions that are not in the documentation below, they are probably added by a plugin, and you should refer to their documentation.
2020
</Alert>
2121

22-
2322
### Trigger
2423

2524
The trigger decides when to execute the action. Triggers also provide the payload which is available in the condition and action.
@@ -68,6 +67,23 @@ Learn more: <a href="https://symfony.com/doc/current/reference/formats/expressio
6867

6968
Sends a POST request to the given webhook URL.
7069

70+
For example, to send data to Zapier:
71+
72+
- **Webhook URL**: The webhook URL given by Zapier (Catch Raw Hook)
73+
- **Data**: The data sent to Zapier, for example with a Doctrine Topic trigger:
74+
75+
```twig
76+
{{ {
77+
topic: entity.title,
78+
content: entity.firstComment.content
79+
}|json_encode|raw }}
80+
```
81+
82+
<Alert severity="info">
83+
The example creates the data object, then JSON encodes it and dumps the raw output. This method is recommended since it
84+
takes care of escaping quotes and slashes which may break your JSON.
85+
</Alert>
86+
7187
#### HTTP Request
7288

7389
Call any external API using a HTTP request.

src/app/user-manual/page.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import Link from 'next/link';
55
- <Link href="/user-manual/admin-panel">Admin Panel</Link>
66
- <Link href="/user-manual/forum">Forums</Link>
77
- <Link href="/user-manual/cms">Content Management System</Link>
8+
- <Link href="/user-manual/automation">Automation</Link>
89
- <Link href="/user-manual/calendar">Calendar</Link>
910
- <Link href="/user-manual/menu-builder">Menu Builder</Link>
1011
- <Link href="/user-manual/automation">Automation</Link>

src/app/user-manual/security/page.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ There are 3 roles within forumify that can not be deleted or modified:
5151
- **Super Admin**: The Super Admin role bypasses any and all security checks.
5252
It's the most powerful role in your system and should be treated with extreme care.
5353
Only the website's owner should have this role. It is given to the user who installed the platform.
54-
- **User**: The User role is automatically assigned to any user that is logged in.
55-
- **Guest**: The Guest role is automatically assigned to any user that is *not* logged in.
54+
- **User**: The User role is automatically assigned to every user that is logged in.
55+
- **Guest**: The Guest role is automatically assigned to every user that is *not* logged in.
5656

5757
So if you want to grant access to **all** users, all you have to do is assign the permission to both *User* and *Guest* roles.
5858

@@ -61,7 +61,7 @@ So if you want to grant access to **all** users, all you have to do is assign th
6161
The most common security mechanism you will see in action is ACL. ACL allows you to enable an action for each role.
6262

6363
ACLs are not managed in the Role's setting, but they are managed in the entity that defines them.
64-
Usually when you see a <LockSimple /> button, you are editing the access control for that entity.
64+
Usually when you see a <LockSimple /> button, you are editing the Access Control List for that entity.
6565
Entities that are governed by ACLs define their own permissions.
6666
For example, a forum defines the permissions "view", "create topic", "create comment",...
6767

0 commit comments

Comments
 (0)