SAM0123-231: Remove Kafka configuration and infrastructure references; simplify README documentation.
This commit is contained in:
@@ -1,7 +1,3 @@
|
|||||||
# Kafka
|
|
||||||
KAFKA_SERVERS="localhost:9092"
|
|
||||||
EXPORT_TO_KAFKA="false"
|
|
||||||
|
|
||||||
# Redis
|
# Redis
|
||||||
REDIS_HOST="localhost"
|
REDIS_HOST="localhost"
|
||||||
REDIS_PORT="6379"
|
REDIS_PORT="6379"
|
||||||
|
|||||||
18
README.md
18
README.md
@@ -156,7 +156,7 @@ pytest
|
|||||||
|
|
||||||
# Run with coverage
|
# Run with coverage
|
||||||
pytest --cov=ingestor --cov-report=html
|
pytest --cov=ingestor --cov-report=html
|
||||||
|
```
|
||||||
|
|
||||||
### Populating Redis with OPC Configuration
|
### Populating Redis with OPC Configuration
|
||||||
|
|
||||||
@@ -325,7 +325,6 @@ sientia-dataops-opc-ingestor/
|
|||||||
├── simulator/ # OPC simulation and testing tools
|
├── simulator/ # OPC simulation and testing tools
|
||||||
├── scripts/ # Ops scripts (e.g. OPC UA cert generation)
|
├── scripts/ # Ops scripts (e.g. OPC UA cert generation)
|
||||||
├── tests/ # Test suite
|
├── tests/ # Test suite
|
||||||
├── docker-compose.yaml # Infrastructure services
|
|
||||||
└── requirements.txt # Python dependencies
|
└── requirements.txt # Python dependencies
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -395,10 +394,6 @@ export LOG_LEVEL=DEBUG
|
|||||||
- Use type hints where appropriate
|
- Use type hints where appropriate
|
||||||
- Follow the established architectural patterns
|
- Follow the established architectural patterns
|
||||||
|
|
||||||
## 📄 License
|
|
||||||
|
|
||||||
This project is licensed under the terms specified in the LICENSE file.
|
|
||||||
|
|
||||||
## 🆘 Support
|
## 🆘 Support
|
||||||
|
|
||||||
For support and questions:
|
For support and questions:
|
||||||
@@ -410,14 +405,3 @@ For support and questions:
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Note**: This OPC Ingestor is designed for production use in industrial environments. Ensure proper security configuration and network isolation for production deployments.
|
**Note**: This OPC Ingestor is designed for production use in industrial environments. Ensure proper security configuration and network isolation for production deployments.
|
||||||
|
|
||||||
This comprehensive documentation provides:
|
|
||||||
|
|
||||||
1. **Complete feature overview** with architectural details
|
|
||||||
2. **Detailed installation and setup instructions**
|
|
||||||
3. **Comprehensive configuration documentation**
|
|
||||||
4. **Performance tuning and troubleshooting guides**
|
|
||||||
5. **Development guidelines and contribution standards**
|
|
||||||
6. **Updated docstrings** for all major classes and methods
|
|
||||||
|
|
||||||
The documentation now serves as a complete reference for users, developers, and operators of the OPC Ingestor system.
|
|
||||||
Reference in New Issue
Block a user