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.
144 lines
3.3 KiB
Markdown
144 lines
3.3 KiB
Markdown
# 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**:
|
|
1. Identify documentation affected by change
|
|
2. Update documentation within 1 week of change
|
|
3. Review related documentation for consistency
|
|
4. Update Last Updated date
|
|
|
|
## Review Process
|
|
|
|
### Step 1: Preparation
|
|
|
|
1. Identify documents to review
|
|
2. Gather recent changes and feedback
|
|
3. Review related code/config changes
|
|
|
|
### Step 2: Review
|
|
|
|
1. Check accuracy of information
|
|
2. Verify all links work
|
|
3. Test code examples
|
|
4. Review for clarity and completeness
|
|
5. Check formatting consistency
|
|
|
|
### Step 3: Update
|
|
|
|
1. Make necessary updates
|
|
2. Update Last Updated date
|
|
3. Update related documentation
|
|
4. Update indices if structure changes
|
|
|
|
### Step 4: Documentation
|
|
|
|
1. Document review in review log
|
|
2. Note any issues found and resolved
|
|
3. 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
|
|
|
|
- [Documentation Style Guide](DOCUMENTATION_STYLE_GUIDE.md)
|
|
- [Master Documentation Index](../MASTER_DOCUMENTATION_INDEX.md)
|
|
- [Archive Policy](../archive/ARCHIVE_POLICY.md)
|
|
|
|
---
|
|
|
|
**Last Updated**: 2025-01-27
|
|
**Next Review**: 2025-04-27
|
|
|