Add documentation for structures in struct_module/contribs

docs/structures.md

@@ -0,0 +1,129 @@
+# List of Structures in `struct_module/contribs`
+
+## Ansible Playbook
+- **File**: `ansible-playbook.yaml`
+- **Description**: Contains the structure for an Ansible playbook with various components like `main.yml`, `vars.yml`, `tasks/main.yml`, `handlers/main.yml`, `templates/README.md`, and `README.md`.
+
+## CI/CD Pipelines
+- **File**: `ci-cd-pipelines.yaml`
+- **Description**: Defines the structure for CI/CD pipelines including `.gitlab-ci.yml`, `Jenkinsfile`, `.github/workflows/ci.yml`, and `.github/workflows/cd.yml`.
+
+## CloudFormation Files
+- **File**: `cloudformation-files.yaml`
+- **Description**: Contains the structure for AWS CloudFormation files including `template.yaml`, `parameters.json`, and `deploy.sh`.
+
+## Codeowners Configuration
+- **File**: `configs/codeowners.yaml`
+- **Description**: Defines the structure for a `CODEOWNERS` file.
+
+## Devcontainer Configuration
+- **File**: `configs/devcontainer.yaml`
+- **Description**: Contains the structure for a `.devcontainer/devcontainer.json` file.
+
+## Editor Config
+- **File**: `configs/editor-config.yaml`
+- **Description**: Defines the structure for an `.editorconfig` file.
+
+## ESLint Configuration
+- **File**: `configs/eslint.yaml`
+- **Description**: Contains the structure for ESLint configuration files including `.eslintrc.json` and `.eslintignore`.
+
+## JSHint Configuration
+- **File**: `configs/jshint.yaml`
+- **Description**: Defines the structure for JSHint configuration files including `.jshintrc` and `.jshintignore`.
+
+## Prettier Configuration
+- **File**: `configs/prettier.yaml`
+- **Description**: Contains the structure for Prettier configuration files including `.prettierrc` and `.prettierignore`.
+
+## Docker Files
+- **File**: `docker-files.yaml`
+- **Description**: Defines the structure for Docker-related files including `Dockerfile`, `.dockerignore`, `docker-compose.yml`, and `.env`.
+
+## Documentation Template
+- **File**: `documentation-template.yaml`
+- **Description**: Contains the structure for documentation files including `README.md`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `LICENSE.md`.
+
+## Git Hooks
+- **File**: `git-hooks.yaml`
+- **Description**: Defines the structure for Git hook scripts including `.git/hooks/pre-commit`, `.git/hooks/pre-push`, and `.git/hooks/commit-msg`.
+
+## GitHub Workflows
+- **File**: `github/workflows/execute-tf-workflow.yaml`
+- **Description**: Contains the structure for a GitHub Actions workflow to execute Terraform.
+
+## GitHub Pre-commit Workflow
+- **File**: `github/workflows/pre-commit.yaml`
+- **Description**: Defines the structure for a GitHub Actions workflow to run pre-commit hooks.
+
+## GitHub Release Drafter Workflow
+- **File**: `github/workflows/release-drafter.yaml`
+- **Description**: Contains the structure for a GitHub Actions workflow to draft releases.
+
+## GitHub Run Struct Workflow
+- **File**: `github/workflows/run-struct.yaml`
+- **Description**: Defines the structure for a GitHub Actions workflow to run Struct.
+
+## Helm Chart
+- **File**: `helm-chart.yaml`
+- **Description**: Contains the structure for a Helm chart including `Chart.yaml`, `values.yaml`, and various templates.
+
+## Kubernetes Manifests
+- **File**: `kubernetes-manifests.yaml`
+- **Description**: Defines the structure for Kubernetes manifests including `deployment.yaml`, `service.yaml`, `ingress.yaml`, `configmap.yaml`, `secrets.yaml`, and `README.md`.
+
+## Generic Project
+- **File**: `project/generic.yaml`
+- **Description**: Contains the structure for a generic project with various configuration files and folders.
+
+## Go Project
+- **File**: `project/go.yaml`
+- **Description**: Defines the structure for a Go project including `.editorconfig`, `.env`, `.gitignore`, `LICENSE`, `README.md`, `main.go`, and various folders.
+
+## Java Project
+- **File**: `project/java.yaml`
+- **Description**: Contains the structure for a Java project including `.editorconfig`, `.env`, `.gitignore`, `LICENSE`, `README.md`, `pom.xml`, and various folders.
+
+## Node.js Project
+- **File**: `project/nodejs.yaml`
+- **Description**: Defines the structure for a Node.js project.
+
+## Python Project
+- **File**: `project/python.yaml`
+- **Description**: Contains the structure for a Python project.
+
+## Ruby Project
+- **File**: `project/ruby.yaml`
+- **Description**: Defines the structure for a Ruby project.
+
+## Rust Project
+- **File**: `project/rust.yaml`
+- **Description**: Contains the structure for a Rust project.
+
+## AWS Accounts Terraform
+- **File**: `terraform/apps/aws-accounts.yaml`
+- **Description**: Defines the structure for AWS accounts Terraform configuration.
+
+## Environments Terraform
+- **File**: `terraform/apps/environments.yaml`
+- **Description**: Contains the structure for environments Terraform configuration.
+
+## Generic Terraform
+- **File**: `terraform/apps/generic.yaml`
+- **Description**: Defines the structure for generic Terraform configuration.
+
+## GitHub Organization Terraform
+- **File**: `terraform/apps/github-organization.yaml`
+- **Description**: Contains the structure for GitHub organization Terraform configuration.
+
+## Init Terraform
+- **File**: `terraform/apps/init.yaml`
+- **Description**: Defines the structure for init Terraform configuration.
+
+## Generic Terraform Module
+- **File**: `terraform/modules/generic.yaml`
+- **Description**: Contains the structure for a generic Terraform module.
+
+## Vagrant Files
+- **File**: `vagrant-files.yaml`
+- **Description**: Defines the structure for Vagrant files.