@oriolrius/node-red-contrib-kafka/docs/NODE_NAMES_IMPROVEMENT.md

Node-RED Kafka nodes: Send, Receive, and Schema validation with modern KafkaJS

# Node-RED Node Names Improvement

## Overview

This document outlines the improvements made to the Node-RED Kafka node names to make them shorter, more intuitive, and easier to understand.

## Node Name Changes

### Before vs After

| Node Type | Old Name/Label | New PaletteLabel | New Label | Improvement |
|-----------|----------------|------------------|-----------|-------------|
| **Broker** | "hm-kafka-broker" | "Kafka Broker" | "Kafka Broker" | ✅ Clear, concise connection config |
| **Producer** | "Data to Cloud" | "Kafka Send" | "Kafka Send" | ✅ Direct, action-oriented |
| **Consumer** | "Data Subscription" | "Kafka Receive" | "Kafka Receive" | ✅ Clear receive action |
| **Schema Producer** | "Publish with Schema" | "Kafka Schema Send" | "Kafka Schema Send" | ✅ Consistent with "Send" pattern |

## Benefits of the New Names

### 1. **Consistency**
- All producer/send operations use "Send" terminology
- All consumer/receive operations use "Receive" terminology
- Maintains "Kafka" prefix for brand recognition

### 2. **Clarity**
- **"Kafka Send"** vs "Data to Cloud" - More specific about what it does
- **"Kafka Receive"** vs "Data Subscription" - Clearer action verb
- **"Kafka Schema Send"** vs "Publish with Schema" - Maintains consistency with Send pattern
- **"Kafka Broker"** - Clear configuration node purpose

### 3. **Brevity**
- Shorter names are easier to read in the Node-RED palette
- Reduces cognitive load when building flows
- Better fits in limited palette space

### 4. **Intuitive Understanding**
- New users can immediately understand what each node does
- Action-oriented verbs (Send/Receive) vs abstract concepts
- Clear hierarchy: Broker (config) → Send/Receive (actions)

## Technical Implementation

### Files Modified

1. **kafka-broker.html**: Added paletteLabel and improved label function
2. **kafka-producer.html**: Changed paletteLabel from "Data to Cloud" to "Kafka Send"
3. **kafka-consumer.html**: Changed paletteLabel from "Data Subscription" to "Kafka Receive"
4. **kafka-schema-producer.html**: Changed paletteLabel from "Publish with Schema" to "Kafka Schema Send"

### Documentation Updates

1. **README.md**: Updated node descriptions and parameter sections
2. **tests/README.md**: Updated test descriptions to match new names

## Node Categories

All nodes remain in the **'IOT'** category, maintaining consistency with IoT/edge computing use cases.

## User Experience Impact

### For New Users
- Easier to understand node purposes at first glance
- Consistent naming pattern reduces learning curve
- Clear action words help with flow design

### For Existing Users
- Node functionality remains identical
- Only visual labels change, no breaking changes
- Flows continue to work without modification

## Future Considerations

The new naming pattern provides a foundation for:
- Additional Kafka-related nodes (e.g., "Kafka Admin", "Kafka Stream")
- Consistent naming across other messaging systems
- Better integration with Node-RED's visual flow paradigm

## Conclusion

These improvements make the Kafka nodes more accessible and intuitive while maintaining full backward compatibility. The new names better reflect the actual functionality and follow Node-RED best practices for node naming.