No definition of node in documentation

[raphaelcervantes]

Hi,
I think the documentation would benefit from an explicit definition of a node. There are several references to nodes throughout all of the driplineorg documents, but I didn't find any doc that said "a node is ..." There are lots of definitions for nodes, so I think it would help clear up any confusion.

[raphaelcervantes]

The closest I see to a definition is here: https://driplineorg.github.io/dripline-python/latest/dl_serve.html#instance-node-description

Each instance node defines an object which will be created and configured as part of the service.

Maybe that settles the issue.

[laroque]

I think that reference confuses the issue more than settles it, unfortunately (as you observed), node is one of those terms which can mean different things in different contexts (even absent dripline). In this case:

• often a "node" refers to a computer (as in, 'a worker node'), ie anything which is a "node" in the k8s cluster.
• In this second example, "node" is a unit in a config file. Scarab has "param_node" objects and I believe that the "node" term there is based on the names used by the dependency library (chosen to be consistent and hopefully less confusing, hah)

I don't think we're able to fully deconflict this because we're dependent on multiple pre-existing definitions, but we can try to improve consistency and improve the context so it is hopefully clear. We can also take the solution that language dictionaries already provide a glossary that includes the multiple definitions so at least they're all there and it is (hopefully) clear what the possibilities are.

I can try to look through generally, but if you have specific places where you found it confusing that would be helpful.

[raphaelcervantes]

Node shows up here: https://driplineorg.github.io/dripline/branches/dl3_develop/Wire-Protocol.html?highlight=node
and here: https://driplineorg.github.io/dripline-python/latest/dl_serve.html?highlight=node
and here: https://driplineorg.github.io/dripline-python/latest/dl_serve.html?highlight=node

It's often said that messages get transferred from one node to another, and it's not clear to me which definition of node is being used. I'd probably be able to figure it out if I thought about it more or if I can manage to sleep for more than 4 hours at a time.