This repository contains system requirements documentation for the Code Ocean VPC deployment infrastructure. The documentation is automatically generated from CloudFormation templates and provides a comprehensive overview of the AWS resources, parameters, and configurations required for deploying Code Ocean in your AWS environment.
System requirements documents are organized by version and can be found in the corresponding branches of this repository. For example, system requirements for Code Ocean VPC v3.7.0 can be found in the v3.7.0 branch.
- Navigate to the branch corresponding to your desired Code Ocean version
- Open the
System Requirements.mdfile to view the complete documentation - Use the table of contents and links to navigate to specific sections
- Reference the line numbers to examine specific configurations in the CloudFormation template
The system requirements documentation is generated using Python scripts in the .tools directory:
.tools/generate_requirements.pyThis tool automatically parses the CloudFormation template and creates human-readable documentation with proper links and formatting.