DevOps Demo Application Documentation

Welcome to the documentation for the DevOps Demo Application. This directory contains comprehensive documentation for all aspects of the project.

Documentation Structure

• Development

• Development Guide - How to set up and run the application for local development

• Development Scripts - Utility scripts for development, testing, and deployment

• Deployment

• Deployment Guide - How to deploy the application to AWS ECS using GitHub Actions

• Workflows

• This directory will contain documentation for GitHub Actions workflows

• Git Hooks - Documentation for the pre-commit git hooks setup

• Release Notes - Comprehensive changelog of all project changes

Component-Specific Documentation

• Backend README - Documentation specific to the backend application
• Frontend README - Documentation specific to the frontend application

Contributing to Documentation

When adding new documentation:

1. Place it in the appropriate subdirectory based on its category
2. Update this index file to include a link to the new documentation
3. Follow the established Markdown formatting conventions
4. Include clear headings, code examples, and explanations

For substantial documentation changes, please create a feature branch and submit a pull request.