From ee9b5ba957c36340091c0a13c730e919c598cfc5 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Fri, 21 Jun 2024 16:04:05 +0100 Subject: [PATCH 1/2] Add certified nodes process to handbook --- src/handbook/development/certified-nodes.md | 28 +++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 src/handbook/development/certified-nodes.md diff --git a/src/handbook/development/certified-nodes.md b/src/handbook/development/certified-nodes.md new file mode 100644 index 0000000000..38ae75f8e4 --- /dev/null +++ b/src/handbook/development/certified-nodes.md @@ -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 withing 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 + + From f744b14d3f25d5940085f623b0c6ab756aca7f45 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Mon, 24 Jun 2024 12:56:46 +0100 Subject: [PATCH 2/2] Update src/handbook/development/certified-nodes.md Co-authored-by: Joe Pavitt <99246719+joepavitt@users.noreply.github.com> --- src/handbook/development/certified-nodes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/handbook/development/certified-nodes.md b/src/handbook/development/certified-nodes.md index 38ae75f8e4..d905bcfcd7 100644 --- a/src/handbook/development/certified-nodes.md +++ b/src/handbook/development/certified-nodes.md @@ -8,7 +8,7 @@ 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 withing FlowFuse. +instances within FlowFuse. ## Proposing a new node to be included