-
Notifications
You must be signed in to change notification settings - Fork 224
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Docs related to workflows and modules #2102
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- This branch serves as the main branch for the workflow docs - All the PRs will be merged into this branch and at the time of feature release this PR will be merged into the main branch. - Basic structure of workflows
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
jnikhila
changed the title
feat: Docs related to workflows feature
feat: Docs related to workflows
Feb 7, 2024
jnikhila
changed the title
feat: Docs related to workflows
feat: Docs related to workflows and modules
Mar 11, 2024
## Description Provide a concise summary of the changes made in this pull request. - ## Type of PR Check the appropriate box: - [ ] Review Fixes - [ ] Documentation Overhaul - [ ] Feature/Story - Link one or more Engineering Tickets * - [ ] A-Force - [ ] Error in documentation ## Documentation tickets Link to one or more documentation tickets: - ## Checklist Choose only the ones that are applicable. - [ ] Checked for Grammarly suggestions. - [ ] Adhered to the writing checklist. - [ ] Adhered the media checklist. - [ ] Verified and updated cross-references or added redirect rules. - [ ] Tested the redirect rules on deploy preview. - [ ] Validated the modifications made to the content on deploy preview. - [ ] Validated the CSS modifications on different screen sizes. --------- Co-authored-by: Nikhila Jain <[email protected]>
## Description Provide a concise summary of the changes made in this pull request. - A new section for Workflows added to the sidebar - Workflows - [Overview](https://appsmith-docs-git-feat-workflow-tutorial-get-appsmith.vercel.app/workflows) - A brief about workflows, components, and links to get started. - Tutorial - [Create a basic workflow](https://appsmith-docs-git-feat-workflow-tutorial-get-appsmith.vercel.app/workflows/tutorials/create-workflow) - Trigger it from the Appsmith app - Integrate on Appsmith events and execute the workflow - Added an interactive Arcade so that users can learn in an interactive mode - How-To guides - [Create Approval Workflow](https://appsmith-docs-git-feat-workflow-tutorial-get-appsmith.vercel.app/workflows/how-to-guides/create-approval-workflow) - How to create an approval workflow that showcases a refund approval example - Create a workflow to handle automated approvals and manual approval/rejections - Trigger workflow to add new refund requests to the workflow - Read the pending refund requests in the Appsmith app - Take action in the Appsmith app - Resolve requests in Workflow - Notify users of the outcome - Reference - [Workflow Queries](https://appsmith-docs-git-feat-workflow-tutorial-get-appsmith.vercel.app/workflows/reference/workflow-queries) - To give information on the type of workflow queries and their parameters - [Workflow Functions](https://appsmith-docs-git-feat-workflow-tutorial-get-appsmith.vercel.app/workflows/reference/workflow-functions) - [Concept](https://appsmith-docs-git-feat-workflow-tutorial-get-appsmith.vercel.app/workflows/concepts/workflows-in-appsmith) - To provide information on the Workflow feature in Appsmith and its key capabilities. - Granular Access Control - [ Roles >> Application resources](https://appsmith-docs-git-feat-workflow-tutorial-get-appsmith.vercel.app/advanced-concepts/granular-access-control/roles#application-resources) - Updates to add Workflow permissions ## Type of PR Check the appropriate box: - [ ] Review Fixes - [ ] Documentation Overhaul - [x] Feature/Story - Link one or more Engineering Tickets * - [ ] A-Force - [ ] Error in documentation ## Documentation tickets Link to one or more documentation tickets: - #2076 - #2118 - #2100 - #2099 ## Checklist Choose only the ones that are applicable. - [x] Checked for Grammarly suggestions. - [x] Adhered to the writing checklist. - [x] Adhered the media checklist. - [ ] Verified and updated cross-references or added redirect rules. - [ ] Tested the redirect rules on deploy preview. - [ ] Validated the modifications made to the content on deploy preview. - [ ] Validated the CSS modifications on different screen sizes.
Nikhil-Nandagopal
previously approved these changes
Mar 11, 2024
harshilp24
previously approved these changes
Mar 12, 2024
harshilp24
approved these changes
Mar 12, 2024
gugulet-hu-spreadai
pushed a commit
to spread-ai/docs-appsmith-fork
that referenced
this pull request
Sep 30, 2024
## Description Provide a concise summary of the changes made in this pull request. - A new section for Workflows and Modules added to the sidebar - Workflows - Overview - The Landing page that gives an overview of the Workflow feature - what and how it works? - Tutorial The tutorial covers how to: - Create a basic workflow - Configure Webhook Trigger - Trigger it from the Appsmith app - Integrate on Appsmith events and execute the workflow - Added an interactive Arcade so that users can learn in an interactive mode - How-To guides - Create Approval Workflow - How to create an approval workflow that showcases a refund approval example - Create a workflow to handle automated approvals and manual approval/rejections - Trigger workflow to add new refund requests to the workflow - Read the pending refund requests in the Appsmith app - Take action in the Appsmith app - Resolve requests in Workflow - Notify users of the outcome - Reference - To give information on the type of workflow queries and their parameters Granular Access Control - Roles >> Application resources - Updates to add Workflow permissions - Modules - Overview - The Landing page that gives an overview of the Module feature - what and how it works? - Tutorial The tutorial covers how to: - Create and configure the query module - Integrate the module into your app - Pass parameters to the module - Create and configure the JS module - Integrate and execute the module in your app ## Type of PR Check the appropriate box: - [ ] Review Fixes - [ ] Documentation Overhaul - [x] Feature/Story - Link one or more Engineering Tickets * - [ ] A-Force - [ ] Error in documentation ## Documentation tickets Link to one or more documentation tickets: - ## Checklist Choose only the ones that are applicable. - [ ] Checked for Grammarly suggestions. - [ ] Adhered to the writing checklist. - [ ] Adhered the media checklist. - [ ] Verified and updated cross-references or added redirect rules. - [ ] Tested the redirect rules on deploy preview. - [ ] Validated the modifications made to the content on deploy preview. - [ ] Validated the CSS modifications on different screen sizes. --------- Co-authored-by: Harshil Patel <[email protected]> Co-authored-by: harshilp24 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Provide a concise summary of the changes made in this pull request.
A new section for Workflows and Modules added to the sidebar
Workflows
Overview
- The Landing page that gives an overview of the Workflow feature - what and how it works?
Tutorial
The tutorial covers how to:
- Create a basic workflow
- Configure Webhook Trigger
- Trigger it from the Appsmith app
- Integrate on Appsmith events and execute the workflow
- Added an interactive Arcade so that users can learn in an interactive mode
How-To guides
- Create Approval Workflow
- How to create an approval workflow that showcases a refund approval example
- Create a workflow to handle automated approvals and manual approval/rejections
- Trigger workflow to add new refund requests to the workflow
- Read the pending refund requests in the Appsmith app
- Take action in the Appsmith app
- Resolve requests in Workflow
- Notify users of the outcome
Reference
Granular Access Control
- Roles >> Application resources
- Updates to add Workflow permissions
Modules
- The Landing page that gives an overview of the Module feature - what and how it works?
The tutorial covers how to:
- Create and configure the query module
- Integrate the module into your app
- Pass parameters to the module
- Create and configure the JS module
- Integrate and execute the module in your app
Type of PR
Check the appropriate box:
Review Fixes
Documentation Overhaul
Feature/Story
Link one or more Engineering Tickets
A-Force
Error in documentation
Documentation tickets
Link to one or more documentation tickets:
Checklist
Choose only the ones that are applicable.