Skip to content

Commit d59f3c4

Browse files
Merge pull request #57 from Data-Bishop/dev
update doc/codebase and readme
2 parents a9593fc + 26e037c commit d59f3c4

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This product demonstrates the proposed architecture and solution for enabling la
88
## Team members
99
- Choice Ugwuede [Github](https://github.com/Choiceugwuede)
1010
- Abasifreke Nkanang [Github](https://github.com/Data-Bishop)
11-
- Adewunmi Olaniyi Oluwaseyi [Github](https://github.com/protechanalysis)
11+
- Adewunmi Olaniyi [Github](https://github.com/protechanalysis)
1212
- David Mark [Github](https://github.com/markdave123-py)
1313

1414
## Overview
@@ -20,15 +20,16 @@ It is designed to be cost-effective, easy to maintain, and ready for client onbo
2020

2121
| Component | Purpose |
2222
|:----------|:--------|
23-
| [CI/CD (GitHub Actions)](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/tree/main/.github/workflows) | Automates code deployment and infrastructure updates |
24-
| [Infrastructure (Terraform](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/tree/main/infrastructure) | Automates cloud setup (IAM, S3, networking) |
25-
| [Orchestration (Apache Airflow)](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/tree/main/orchestration) | Manages data pipeline workflows |
26-
| [Spark jobs (PySpark)](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/tree/main/spark_jobs) | Simulates realistic e-commerce datasets and processing |
23+
| [CI/CD (GitHub Actions)](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/blob/main/docs/codebase_and_ci_cd.md) | Automates code deployment and infrastructure updates |
24+
| [Infrastructure (Terraform](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/blob/main/docs/terraform_infrastructure.md) | Automates cloud setup (IAM, S3, networking) |
25+
| [Orchestration (Apache Airflow)](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/blob/main/docs/airflow_documentation.md) | Manages data pipeline workflows |
26+
| [Spark jobs (PySpark)](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/blob/main/docs/spark_jobs.md) | Simulates realistic e-commerce datasets and processing |
2727

2828
## ☁️ Architecture Overview
2929
![workflow](/assests/workflow.svg)
3030
Clear [architecture documentation](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/blob/main/docs/architecture.md) outlining the platform’s design.
3131

32+
For Architecture documentation[ Click here](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/blob/main/docs/architecture.md)
3233

3334
## 🛠️ Technologies Used
3435
- Cloud: AWS (S3, IAM)
@@ -77,4 +78,3 @@ Clear separation between raw and processed data zones in AWS S3, following data
7778
- Comprehensive [documentations](https://github.com/Data-Bishop/Team5-BuildItAll-Data-Platform/tree/main/docs) to support onboarding, repository cloning, and commercial deployment.
7879

7980

80-

docs/codebase_and_ci_cd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## **1. Repository Structure**
44
The repository is organized into directories and files that represent the different components of the **BuildItAll Data Platform**. Below is an overview of the structure:
5-
5+
```graphql
66
BuildItAll_Data_Platform/
77
├── .github/
88
│ └── workflows/ # GitHub Actions workflows for CI/CD
@@ -45,7 +45,7 @@ BuildItAll_Data_Platform/
4545
│ ├── requirements.txt # Python dependencies for Spark jobs
4646
│ ├── bootstrap.sh # Bootstrap script for EMR cluster
4747
├── .gitignore # Git ignore rules
48-
48+
```
4949
---
5050

5151
## **2. CI/CD**

0 commit comments

Comments
 (0)