docs: Comprehensive README with repository structure and setup guide#1
Merged
Conversation
Add detailed documentation including repository structure, key features, technologies used, prerequisites, getting started guide, and links to additional documentation resources.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR significantly enhances the project documentation by replacing the minimal README with a comprehensive guide that covers the repository structure, features, technologies, prerequisites, and getting started instructions.
Key Changes
Repository Structure Documentation - Added detailed directory tree explaining the purpose of each major directory (infra-azure-provisioning, cloud-devops, multi-tenant-devops, mtmaps, adops, scripting)
Project Overview - Clarified that this is an enterprise-grade infrastructure-as-code repository for OSDU and Trackonomy platforms on Microsoft Azure
Feature Highlights - Documented key capabilities including:
Technology Stack - Added comprehensive table of technologies used (Terraform, Azure, Kubernetes, Helm, Istio, databases, CI/CD platforms, and languages)
Prerequisites - Listed required tools and versions (Terraform 1.11.2+, Go 1.24+, Python 3.5.3+, Azure CLI, kubectl, Helm)
Getting Started Guide - Provided step-by-step instructions for:
Infrastructure Templates Reference - Added table describing main Terraform templates (central_resources, service_resources, data_partition, monitoring_resources)
Terraform Modules Reference - Listed core Azure modules available (AKS, CosmosDB, Key Vault, networking, PostgreSQL, Redis, Service Bus, storage)
Helm Charts Overview - Documented available charts for OSDU services, service mesh, and workflow orchestration
Scripts Reference - Added table of utility scripts for common Azure operations
Architecture Documentation - Noted the C4 Model diagrams available in mtmaps directory
CI/CD Pipelines - Listed supported platforms (GitLab CI, Azure DevOps, GitHub Actions)
Additional Resources - Provided pointers to detailed documentation, contributing guidelines, and license information
Implementation Details
The README now serves as a comprehensive entry point for developers and operators, providing both high-level context and practical guidance for working with the infrastructure-as-code repository. The documentation is organized hierarchically from overview to specific implementation details, making it accessible to both new and experienced users.