1fb7266469
- 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.
3.3 KiB
3.3 KiB
Documentation Review Schedule
Last Updated: 2025-01-27
Status: Active
Overview
This document defines the review schedule for all documentation in the docs/ directory.
Review Frequency
Quarterly Reviews (Every 3 Months)
Documents:
- Deployment guides
- Configuration guides
- Architecture documentation
- Quick start guides
- Troubleshooting guides
Review Date: First week of each quarter (January, April, July, October)
Checklist:
- Information is accurate and current
- Links work correctly
- Code examples tested
- Prerequisites updated
- Related documentation links current
- Last Updated date reflects review
Annual Reviews (Once Per Year)
Documents:
- Governance documentation
- Style guide
- Archive policy
- Review schedule (this document)
Review Date: January of each year
Checklist:
- Policies still relevant
- Processes still effective
- Updates needed
As-Needed Reviews
Triggers:
- Code changes that affect documented functionality
- API changes
- Configuration changes
- User feedback indicating issues
- New features requiring documentation
Process:
- Identify documentation affected by change
- Update documentation within 1 week of change
- Review related documentation for consistency
- Update Last Updated date
Review Process
Step 1: Preparation
- Identify documents to review
- Gather recent changes and feedback
- Review related code/config changes
Step 2: Review
- Check accuracy of information
- Verify all links work
- Test code examples
- Review for clarity and completeness
- Check formatting consistency
Step 3: Update
- Make necessary updates
- Update Last Updated date
- Update related documentation
- Update indices if structure changes
Step 4: Documentation
- Document review in review log
- Note any issues found and resolved
- Update review schedule if needed
Review Assignments
Documentation Owners
Assign owners for each documentation section:
- Architecture: [Owner]
- Deployment: [Owner]
- Configuration: [Owner]
- Operations: [Owner]
- Guides: [Owner]
- API: [Owner]
Review Responsibilities
- Owners: Primary responsibility for their section
- Team: Review and provide feedback
- Maintainer: Coordinate reviews and updates
Review Checklist
For each document reviewed:
- Accuracy: Information is correct and current
- Completeness: All necessary information included
- Clarity: Easy to understand
- Consistency: Follows style guide
- Links: All links work
- Examples: Code examples tested
- Metadata: Has last updated date, status
- Cross-references: Links to related docs
- Prerequisites: Clearly stated
- Troubleshooting: Common issues addressed
Review Log
2025 Q1 (January 2025)
- Date: 2025-01-27
- Reviewed: Initial review schedule created
- Updates: Documentation review process established
- Next Review: 2025-04-27
Related Documentation
Last Updated: 2025-01-27
Next Review: 2025-04-27