Add Oracle Aggregator and CCIP Integration
- Introduced Aggregator.sol for Chainlink-compatible oracle functionality, including round-based updates and access control. - Added OracleWithCCIP.sol to extend Aggregator with CCIP cross-chain messaging capabilities. - Created .gitmodules to include OpenZeppelin contracts as a submodule. - Developed a comprehensive deployment guide in NEXT_STEPS_COMPLETE_GUIDE.md for Phase 2 and smart contract deployment. - Implemented Vite configuration for the orchestration portal, supporting both Vue and React frameworks. - Added server-side logic for the Multi-Cloud Orchestration Portal, including API endpoints for environment management and monitoring. - Created scripts for resource import and usage validation across non-US regions. - Added tests for CCIP error handling and integration to ensure robust functionality. - Included various new files and directories for the orchestration portal and deployment scripts.
This commit is contained in:
60
docs/examples/README.md
Normal file
60
docs/examples/README.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# Examples Directory
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Status**: Active
|
||||
|
||||
This directory contains reusable code examples and sample configurations for the project.
|
||||
|
||||
## Example Categories
|
||||
|
||||
### Configuration Examples
|
||||
- Environment variable examples
|
||||
- Configuration file examples
|
||||
- Terraform examples
|
||||
|
||||
### Deployment Examples
|
||||
- Deployment script examples
|
||||
- Kubernetes manifest examples
|
||||
- Deployment workflow examples
|
||||
|
||||
### Integration Examples
|
||||
- API usage examples
|
||||
- SDK examples
|
||||
- Integration code samples
|
||||
|
||||
## Adding Examples
|
||||
|
||||
1. Create example file with clear naming
|
||||
2. Include comments explaining the example
|
||||
3. Test the example to ensure it works
|
||||
4. Reference in documentation
|
||||
|
||||
## Example Format
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# Example: Deploy contracts
|
||||
# Description: This example shows how to deploy contracts
|
||||
|
||||
# Set environment variables
|
||||
export RPC_URL="https://rpc.d-bis.org"
|
||||
export PRIVATE_KEY="your-private-key"
|
||||
|
||||
# Deploy contracts
|
||||
./scripts/deployment/deploy-contracts.sh
|
||||
```
|
||||
|
||||
## Current Examples
|
||||
|
||||
*Examples are embedded in documentation guides. Add standalone examples here as needed.*
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Configuration Index](../configuration/CONFIGURATION_INDEX.md)
|
||||
- [Deployment Guide](../deployment/DEPLOYMENT.md)
|
||||
- [Integration Guide](../guides/INTEGRATION_GUIDE.md)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
|
||||
Reference in New Issue
Block a user