Skip to content

Commit

Permalink
fix: Plugins docs polish.
Browse files Browse the repository at this point in the history
  • Loading branch information
SamTolmay committed May 24, 2023
1 parent 7335dd8 commit 286b01f
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 4 deletions.
18 changes: 16 additions & 2 deletions packages/docs/plugins/plugins-actions.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2020-2023 Lowdefy, Inc

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

_ref:
path: templates/general.yaml.njk
vars:
Expand Down Expand Up @@ -90,5 +104,5 @@ _ref:
vars:
previous_page_title: Developing Plugins
previous_page_id: plugins-dev
next_page_title: Operators
next_page_id: plugins-operators
next_page_title: Blocks
next_page_id: plugins-blocks
21 changes: 21 additions & 0 deletions packages/docs/plugins/plugins-connections.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2020-2023 Lowdefy, Inc

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

_ref:
path: templates/general.yaml.njk
vars:
Expand Down Expand Up @@ -52,3 +66,10 @@ _ref:
export default AxiosHttp;
```
- _ref:
path: templates/navigation_buttons.yaml
vars:
previous_page_title: Blocks
previous_page_id: plugins-blocks
next_page_title: Operators
next_page_id: plugins-operators
25 changes: 25 additions & 0 deletions packages/docs/plugins/plugins-dev.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2020-2023 Lowdefy, Inc

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

_ref:
path: templates/general.yaml.njk
vars:
Expand All @@ -14,6 +28,17 @@ _ref:
> In this documentation the collection of blocks, connections, actions, etc. will be referred to as _types_, not to be confused with Typescript types.
- id: breaking_changes_alert
type: Alert
properties:
type: warning
showIcon: false
message: The Lowdefy plugin system is under active development and breaking changes might be made in a minor version update.

- id: md1
type: MarkdownWithCode
properties:
content: |
A plugin package needs to include the following:
- A `package.json` file which declares the package and exports the plugin types.
Expand Down
14 changes: 14 additions & 0 deletions packages/docs/plugins/plugins-introduction.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2020-2023 Lowdefy, Inc

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

_ref:
path: templates/general.yaml.njk
vars:
Expand Down
16 changes: 14 additions & 2 deletions packages/docs/plugins/plugins-operators.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2020-2023 Lowdefy, Inc

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

_ref:
path: templates/general.yaml.njk
vars:
Expand All @@ -17,10 +31,8 @@ _ref:
Client parameters:
- `actions: object`: The actions data object.
- `args: array`: If the operator is used inside a `_function` operator, `args` is an array of arguments passed to the function.
- `arrayIndices: array`. ??
- `basePath: string`: The configured app URL basePath.
- `event: object`: The event data object.
- `eventLog: array`:
- `globals: object`: Commonly used Javascript global objects. These are passed to the operator for easier testing.
- `document: object`: The browser [`window.document`](https://developer.mozilla.org/en-US/docs/Web/API/Document/Document) global variable.
- `window: object`: The browser [`window`](https://developer.mozilla.org/en-US/docs/Web/API/Window) global variable.
Expand Down

0 comments on commit 286b01f

Please sign in to comment.