PromucFlow_constructor/contributions/docs/InternalFunctions.md

31 lines
676 B
Markdown
Raw Permalink Normal View History

# Internal Function docs
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
Steps to contribute:
2020-10-01 10:58:15 +00:00
1. Create a appsmith-docs/function-reference/<function>.md file.
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
2. Follow the [asset-upload](UploadingAssets.md) guidelines to upload and use an asset in the docs.
## Functions docs template
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
Copy paste this template in the file you are updating
2020-10-01 10:49:20 +00:00
```bash
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
2020-10-01 10:58:15 +00:00
# Function Name
Add the description here
2020-10-01 10:49:20 +00:00
## Signature
##
2020-10-01 10:58:15 +00:00
function signature wrapped in code blocks
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
2020-10-01 10:49:20 +00:00
#### Arguments
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
2020-10-01 10:49:20 +00:00
| Argument Name | Description |
| :--- | :--- |
| **Argument Name** | Argument Description |
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
2020-10-01 10:58:15 +00:00
## Image / gif of the function being used
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
```
2020-10-01 10:58:15 +00:00
[Example Doc](https://github.com/appsmithorg/appsmith-docs/blob/v1.2/function-reference/show-modal.md)