refactor extensions docs

This commit is contained in:
burnettk 2024-06-18 13:24:31 -04:00
parent d3ca54c1a7
commit 41bb44093b
No known key found for this signature in database
6 changed files with 13 additions and 12 deletions

View File

@ -4,12 +4,11 @@ Extensions in SpiffArena provide a mechanism to augment the software with custom
By leveraging extensions, users can implement functions or features not present in the standard offering.
This powerful feature ensures adaptability to various business needs, from custom reports to specific user tools.
Here are some of the key aspects of using Extensions:
At a high level:
- Extensions are implemented within the process model repository.
- Once an extension is created, it can be made accessible via various UI elements which can be specified in its `extension_uischema.json` file.
- Access to an extension can be set up via permissions.
- Extensions are implemented as process models within the process model repository.
- Configuration for an extension can be found and modified in its `extension_uischema.json` file.
- Access to an extension can be set up via permissions.
![Extensions](images/Extensions_dashboard.png)
@ -53,12 +52,12 @@ If your organization has specific needs not catered to by the standard SpiffAren
Here are some of the use cases already implemented by our users:
- Implementing a time tracking system.
- Creating custom reports tailored to your business metrics.
- Incorporating arbitrary content into custom pages using markdown.
- Creating and accessing tailor-made APIs.
- Rendering the output of these APIs using jinja templates and markdown.
- Implementing a time tracking system
- Creating custom reports tailored to your business metrics
- Incorporating arbitrary content into custom pages using markdown (as in the above example)
- Creating and accessing tailor-made APIs
- Rendering the output of these APIs using jinja templates and markdown
Extensions in SpiffArena offer a robust mechanism to tailor the software to unique business requirements.
When considering an extension, also consider whether the code would be more properly included in the core source code.
When considering an extension, also consider whether the code would be more properly included in the core source code or as a connector inside your [connector proxy](/dev/connector_proxy.md).
In cases where an extension is appropriate, by following the instructions in this guide, organizations can expand the system's functionality to meet their unique needs.

View File

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

View File

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.5 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

@ -38,9 +38,11 @@ Two independent security reviews have been performed on the codebase and mitigat
## Contributing
It would be great to have you contributing to the project.
This is the last page in the Technical Documentation section, where we keep content mainly intended for developers.
And that seems like as good a place as to mention that it would be great to have you contributing to the project!
There is a [Contributing doc](https://github.com/sartography/spiff-arena/blob/main/CONTRIBUTING.rst) that you can follow.
You can find other like-minded people in our [Discord](https://discord.gg/F6Kb7HNK7B).
Thank you!
```mermaid
graph LR

View File

@ -15,6 +15,7 @@ dev/backend.md
dev/frontend.md
dev/connector_proxy.md
dev/how_to_build_a_connector.md
dev/extensions.md
dev/process.md
```
@ -38,7 +39,6 @@ Building_Diagrams/sub-processes_and_call_activities.md
Building_Diagrams/data.md
Building_Diagrams/multiinstance.md
Building_Diagrams/dmn.md
Building_Diagrams/Extensions.md
Building_Diagrams/pools_and_lanes.md
Building_Diagrams/Builtin_examples.md
```