From b413a399fe328df26a8924bbd021295e356014e4 Mon Sep 17 00:00:00 2001 From: satbir121 <39981226+satbir121@users.noreply.github.com> Date: Thu, 1 Oct 2020 14:20:56 +0530 Subject: [PATCH] Adding additional docs contribution files. (#849) --- contributions/docs/action.md | 37 ++++++++++++++++++++++++++++ contributions/docs/asset-upload.md | 3 +++ contributions/docs/db-integration.md | 21 ++++++++++++++++ contributions/docs/widget.md | 32 ++++++++++++++++++++++++ 4 files changed, 93 insertions(+) create mode 100644 contributions/docs/action.md create mode 100644 contributions/docs/asset-upload.md create mode 100644 contributions/docs/db-integration.md create mode 100644 contributions/docs/widget.md diff --git a/contributions/docs/action.md b/contributions/docs/action.md new file mode 100644 index 0000000000..e4d3731506 --- /dev/null +++ b/contributions/docs/action.md @@ -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/.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 +``` + diff --git a/contributions/docs/asset-upload.md b/contributions/docs/asset-upload.md new file mode 100644 index 0000000000..0e1a15e935 --- /dev/null +++ b/contributions/docs/asset-upload.md @@ -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. \ No newline at end of file diff --git a/contributions/docs/db-integration.md b/contributions/docs/db-integration.md new file mode 100644 index 0000000000..f15fcc5a57 --- /dev/null +++ b/contributions/docs/db-integration.md @@ -0,0 +1,21 @@ +# DB Integration docs +Create a appsmith-docs/db-integrations/.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 +``` + diff --git a/contributions/docs/widget.md b/contributions/docs/widget.md new file mode 100644 index 0000000000..ff5e517a51 --- /dev/null +++ b/contributions/docs/widget.md @@ -0,0 +1,32 @@ +# Widget docs +Create a appsmith-docs/widget-reference/.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 | +``` +