Skip to content
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

Add certified nodes process to handbook #2235

Merged
merged 2 commits into from
Jun 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions src/handbook/development/certified-nodes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
navTitle: Certified Nodes
---

FlowFuse maintains a catalogue of nodes from the community that we put through regular checks
to ensure they are of high quality and standards for use by our customers.

The catalogue is maintained in the [certified-nr-nodes](https://github.com/FlowFuse/certified-nr-nodes)(🔒) repository.

A daily GH action runs the audit process across all nodes and regenerates the `catalogue.json` file served to Node-RED
instances within FlowFuse.

## Proposing a new node to be included

1. [Raise an issue](https://github.com/FlowFuse/certified-nr-nodes/issues/new)(🔒) with details of the node to be added.
2. Assign the issue to the CTO (or in his absence, another member of the Engineering Team).

## Adding a new node to the list

Full details on the technical process are provided in the [certified-nr-nodes](https://github.com/FlowFuse/certified-nr-nodes)(🔒) readme.

1. Perform due diligence on the module; how popular is it, is it well maintained, is there a backlog of open issues etc.
2. Add the module to the list held in `modules.json`
3. Run the audit locally to check the current state of the module. Review the results and assess whether we can accept it into the catalogue in its current state.
4. Raise a PR with the updated module list and audit output for the module.
5. Review the PR with the CTO/Engineering Team