Docs Outline to include Certified Node, plus notable ones

[gdziuba]

Description

• Core-Nodes
  • Common
  • Function
  • Network
  • Parsers
  • Sequence
  • Storage
• Non Core-Node
  • Certified-Nodes
  • Should These be Organized Similarly?
  • Common (Vote to be Certified?)
  • e.g. Barcode Scanner

Commonly used nodes—These are Nodes we have found that are often invaluable to many organizations. We wanted to acknowledge them here and give a guide on how to use them. At this point, these nodes haven't gone through the analysis for certification. They may never be certified, but we find it essential to add additional details.

To-Do

• [ ] Outline a structure for each node and information that should be included for each
  • [ ] Similar Nodes eg

Epic/Story

No response

Have you provided an initial effort estimate for this issue?

I have provided an initial effort estimate

[gdziuba]

@Yndira-E and @ZJvandeWeg, This was the results from the discussion from the Content Strategy discussion. The goal of this would be to create an area for Certified Node, then a place for additional Nodes that may or may not make the cut for certified node, but are worth the acknowledgment.

[Yndira-E]

@gdziuba do you mean adding this section:

• Non Core-Node Certified-Nodes Should These be Organized Similarly? Common (Vote to be Certified?) e.g. Barcode Scanner

In the the core nodes page? Here?

[Yndira-E]

Reviewing the discussion and the description, I'm thinking a new section in the /core-nodes page for non core-nodes isn't the right approach.

If I'm understanding correctly, the idea would be to take advantage of the SEO performance of the core-nodes content to expose our certified nodes. Maybe just by changing the page to be something more "generic", we could add core-nodes, certified-nodes, and all the packages we see fit in a more sensible way.

And we'd need some structure for each certified node content. @gdziuba will you take care of the creation of that content?

It could be something like:

Description

• What does it do
• When does it do it
• Which nodes are part of the package

How to use it

• Examples

Why is this core-node relevant/important

WDYT?

[gdziuba]

@Yndira-E, I like this approach.

So if I am thinking we will go from:

/core-nodes to: /nodes/core-nodes and /nodes/certifed-node and it will make room for /node/community-nodes In the future.

Each Node should include the following content (using split as an example):

• Purpose
• Examples
• Node Documentation
  • Inputs
  • Outputs
• References (Optional)
  • Similar Nodes
  • Reference Blogs

[ZJvandeWeg]

In the path of the URL it should be packages I think, not nodes. Also, per REST it should be plural. 😀

[gdziuba]

Works for me. Missed an (s) on the last example.

[gdziuba]

Another thing to consider is that some packages will have multiple nodes. How do we want to handle that? For example, the influxdb node has 3 nodes in it. Do we want a separate page for each one? So it would be something like this:

/packages/certified-nodes/influxdb/influxdb-out /packages/certified-nodes/influxdb/influxdb-batch /packages/certified-nodes/influxdb/influxdb in

[Yndira-E]

@ZJvandeWeg If I understood correctly, you're working on this, right?

[ZJvandeWeg]

@Yndira-E I've done some work on the core nodes to prepare, but I feel like the /node-red page should behave like /node-red/core-nodes/. To have a sidebar so we can build pages on them.

[Yndira-E]

I'm guessing that idea is linked to this comment, right?

We have this issue for the Node-RED page iteration. I'll add your comments there, and we can continue the conversation in that issue.

[gdziuba]

@ZJvandeWeg or @Yndira-E, Where can I find the PR so that I can work on the certified nodes' documentation? ZJ, I think you had created something while in Hannover.

[Yndira-E]

Hi @ZJvandeWeg @gdziuba @sumitshinde-84 and me just had a meeting to discuss this issue, you can find our notes here.

[gdziuba]

Slack thread that discusses thoughts on certified nodes.