Adding additional docs contribution files. (#849)
This commit is contained in:
parent
751dfc92ed
commit
b413a399fe
37
contributions/docs/action.md
Normal file
37
contributions/docs/action.md
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
# Action docs
|
||||||
|
Following actions are available inside code editor in appsmith:
|
||||||
|
api.run()
|
||||||
|
query.run()
|
||||||
|
showModal()
|
||||||
|
closeModal()
|
||||||
|
showAlert()
|
||||||
|
storeValue()
|
||||||
|
download()
|
||||||
|
navigateTo()
|
||||||
|
|
||||||
|
Steps to contribute:
|
||||||
|
1. Create a appsmith-docs/actions/<action>.md file.
|
||||||
|
2. Follow the [asset-upload](./asset-upload.md) guidelines to upload and use an asset in docs.
|
||||||
|
|
||||||
|
## Action docs template
|
||||||
|
Copy paste this template
|
||||||
|
```
|
||||||
|
---
|
||||||
|
description: >-
|
||||||
|
Action Description
|
||||||
|
---
|
||||||
|
|
||||||
|
# ActionName
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
| Param | Description |
|
||||||
|
| :--------- | :----------------- |
|
||||||
|
| **param1** | param1 description |
|
||||||
|
| **param2** | param2 description |
|
||||||
|
| **param3** | param3 description |
|
||||||
|
|
||||||
|
## Image/gif of the widget and the icon in widget creation sidebar.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
```
|
||||||
|
|
||||||
3
contributions/docs/asset-upload.md
Normal file
3
contributions/docs/asset-upload.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Uploading and using assets
|
||||||
|
Use `appsmith-docs/.gitbook/assets/` folder to upload the assets.
|
||||||
|
These assets can be used through the relative path to `.gitbook/assets/asset.jpg` file.
|
||||||
21
contributions/docs/db-integration.md
Normal file
21
contributions/docs/db-integration.md
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
# DB Integration docs
|
||||||
|
Create a appsmith-docs/db-integrations/<integratiom>.md file.
|
||||||
|
Follow the [asset-upload](./asset-upload.md) guidelines to upload and use an asset in docs.
|
||||||
|
|
||||||
|
## Action docs template
|
||||||
|
Copy paste this template
|
||||||
|
```
|
||||||
|
---
|
||||||
|
description: >-
|
||||||
|
Integration Description
|
||||||
|
---
|
||||||
|
|
||||||
|
# Integration Name
|
||||||
|
|
||||||
|
## Link to the official documentation
|
||||||
|
|
||||||
|
## Example of Passing Data from widgets
|
||||||
|
|
||||||
|
## Example of Displaying Data in widgets
|
||||||
|
```
|
||||||
|
|
||||||
32
contributions/docs/widget.md
Normal file
32
contributions/docs/widget.md
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
# Widget docs
|
||||||
|
Create a appsmith-docs/widget-reference/<widget>.md file.
|
||||||
|
Follow the [asset-upload](./asset-upload.md) guidelines to upload and use an asset in docs.
|
||||||
|
|
||||||
|
## Widget docs template
|
||||||
|
Copy paste this template
|
||||||
|
```
|
||||||
|
---
|
||||||
|
description: >-
|
||||||
|
Widget Description
|
||||||
|
---
|
||||||
|
|
||||||
|
# WidgetName
|
||||||
|
|
||||||
|
## Image/gif of the widget and the icon in widget creation sidebar.
|
||||||
|
|
||||||
|
## Usage with dynamic bindings
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
| Property | Description |
|
||||||
|
| :------------ | :-------------------- |
|
||||||
|
| **property1** | Property1 description |
|
||||||
|
| **property2** | Property2 description |
|
||||||
|
| **property3** | Property3 description |
|
||||||
|
|
||||||
|
| Action | Description |
|
||||||
|
| :---------- | :------------------ |
|
||||||
|
| **action1** | action1 description |
|
||||||
|
| **action2** | action2 description |
|
||||||
|
| **action3** | action3 description |
|
||||||
|
```
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user