Update synapse-workflow-examples @ 2025-02-12 22:02:56 UTC

Author: vtx-machine

docs/_build/adminguide.md

@@ -0,0 +1,41 @@
+# Synapse-Workflow-Examples Admin Guide
+
+## Configuration
+
+Optic Workflows is in beta and is controlled by a feature flag in your
+Optic instance, and is enabled by default. See the documentation for
+Optic feature flags
+[here](https://synapse.docs.vertex.link/projects/optic/en/latest/user_interface/devopsguide.html#enable-alpha-beta-features)
+for more information on controlling Optic features.
+
+Synapse-Workflow-Examples requires certain data to be available in the
+current view, and in some cases permissions, in order to fully
+demonstrate the example.
+
+### Data Used by Examples
+
+The `Project Management` workflow requires at least one `proj:project`
+with at least one associated `proj:ticket`.
+
+The `Form + Table + Viewer` workflow requires at least one `ou:org` node
+that has the `:name` property populated. The `contacts` and `hosts`
+tables will be populated by performing pivots from `ou:org` to
+`ps:contact` and `it:host` respectively.
+
+### Permissions
+
+In order to use the `Node Creator` workflow the user must have
+permissions to add nodes in the current view.
+
+## Exported APIs
+
+Synapse-Workflow-Examples does not currently export any APIs.
+
+## Node Actions
+
+Synapse-Workflow-Examples does not currently provide any Optic Node
+Actions.
+
+## Onload Events
+
+Synapse-Workflow-Examples does not use any `onload` events.

docs/_build/changelog.md

@@ -0,0 +1,104 @@
+# Synapse-Workflow-Examples Changelog
+
+## v1.10.0 - 2025-01-17
+
+### Features and Enhancements
+
+-   Updated deprecated `$lib.list()` usage to JSON style syntax.
+
+## v1.9.1 - 2024-11-18
+
+### Bugfixes
+
+-   Fix documentation link for enabling Optic feature flags and update
+    the associated language in the Admin Guide.
+
+## v1.9.0 - 2024-05-15
+
+### Features and Enhancements
+
+-   Update deprecated `$lib.dict()` usage to JSON style syntax.
+
+## v1.8.0 - 2024-02-16
+
+### Features and Enhancements
+
+-   Update user guide documentation.
+
+## v1.7.0 - 2023-03-22
+
+### Features and Enhancements
+
+-   Update Power-Up to build with code signing.
+
+### Bugfixes
+
+-   Fix documentation claiming there are three types of Events when
+    there are only two.
+-   Remove relative links in the user guide since they are broken links
+    on Read the Docs.
+
+## v1.6.0 - 2022-09-14
+
+NOTE: This release requires Optic \>= 2.56.0
+
+### Features and Enhancements
+
+-   Add example using the new Element `buttons` opt to add buttons to
+    Element titlebars.
+-   Add example using the new Element `spinner` opt to add a spinner for
+    any running query.
+
+### Bugfixes
+
+-   Fix bad JSON style dict creation syntax in Datatable example.
+
+## v1.5.0 - 2022-06-20
+
+NOTE: This release requires Optic \>= 2.48.0
+
+### Features and Enhancements
+
+-   Update examples to use new `cssgrid` functionality from Optic
+    v2.45.0.
+
+## v1.4.0 - 2022-04-14
+
+NOTE: This release requires Optic \>= 2.41.0
+
+### Features and Enhancements
+
+-   Update several examples to use new functionality from Optic v2.40.0.
+-   Add example using a `querybar` element to feed results into a
+    `datatable`.
+-   Add example using `researchquery` action.
+-   Add two examples of using the new `tabs` Element from Optic v2.41.0.
+
+## v1.3.0 - 2022-03-22
+
+NOTE: This release requires Optic \>= 2.37.0
+
+### Features and Enhancements
+
+-   Migrate examples and documentation to v2.37.0.
+-   Add more examples to demonstrate new functionality.
+
+## v1.1.0 - 2022-01-14
+
+NOTE: This release requires Optic \>= 2.32.0
+
+### Features and Enhancements
+
+-   Add example and documentation for new `buttons` option on
+    `stormform` element.
+-   Add example and documentation for new `hidden` and `disabled`
+    element options.
+-   Add example and documentation for new `stormconsole` element type.
+-   Improve element documentation
+
+## v1.0.0 - 2021-12-01
+
+### Features and Enhancements
+
+-   Initial release of the `Synapse-Workflow-Examples` Power-Up
+    (requires Optic\>=2.29.0).