2020-10-01 08:50:56 +00:00
|
|
|
# Action docs
|
|
|
|
|
|
|
|
|
|
Steps to contribute:
|
|
|
|
|
1. Create a appsmith-docs/actions/<action>.md file.
|
2020-10-01 09:39:02 +00:00
|
|
|
2. Follow the [asset-upload](UploadingAssets.md) guidelines to upload and use an asset in the docs.
|
2020-10-01 08:50:56 +00:00
|
|
|
|
|
|
|
|
## Action docs template
|
2020-10-01 09:39:02 +00:00
|
|
|
Copy paste this template in the file you are updating
|
2020-10-01 08:50:56 +00:00
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
description: >-
|
|
|
|
|
Action Description
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# ActionName
|
|
|
|
|
|
|
|
|
|
## Parameters
|
|
|
|
|
| Param | Description |
|
|
|
|
|
| :--------- | :----------------- |
|
|
|
|
|
| **param1** | param1 description |
|
|
|
|
|
| **param2** | param2 description |
|
|
|
|
|
| **param3** | param3 description |
|
|
|
|
|
|
2020-10-01 09:42:37 +00:00
|
|
|
## Image/gif of the action used in a widget
|
2020-10-01 08:50:56 +00:00
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
```
|
