docs: Document apps individually

iusztinpaul · Apr 28, 2023 · 2ab23a0 · 2ab23a0
1 parent 1097b05
commit 2ab23a0
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -275,11 +275,17 @@ Airflow will know how to install the packages from this private PyPi server. <br
 Now, go to the `DAGS/All` section and search for the `ml_pipeline` DAG. Toggle the activation button. It should automatically start in a few seconds. Also, you can manually run it hitting the play button from the top-right side of the `ml_pipeline` window.
 
 <p align="center">
-  <img src="images/airflow_ml_pipeline_dag_screenshot.png">
+  <img src="images/airflow_ml_pipeline_dag_overview_screenshot.png">
 </p>
 
 That is it. If all the credentials are setup corectly you can run the entire pipeline with a single button. How cool is that?
 
+Here is how the DAG should look like 👇
+
+<p align="center">
+  <img src="images/airflow_ml_pipeline_dag_screenshot.png">
+</p>
+
 
 #### Clean Up
 ```shell
@@ -360,7 +366,9 @@ Another option is to run every Python script with the `ML_PIPELINE_ROOT_DIR` var
 ML_PIPELINE_ROOT_DIR=/path/to/root/directory/energy-forecasting/repository python -m feature_pipeline.pipeline
 ```
 
-See here how to install every project individually:
+-------
+
+**See here how to install every project individually:**
 - [Feature Pipeline](/feature-pipeline/README.md)
 - [Training Pipeline](/training-pipeline/README.md)
 - [Batch Prediction Pipeline](/batch-prediction-pipeline/README.md)
@@ -369,7 +377,7 @@ See here how to install every project individually:
 ## The Web App
 **We support Docker to run the web app. Check out the [Usage](#usage) section if you only want to run it as a whole.**<br/><br/> 
 
-See here how to install every project individually:
+**See here how to install every project individually:**
 - [API](/app-api/README.md)
 - [Frontend](/app-frontend/README.md)
 - [Monitoring](/app-monitoring/README.md)`

diff --git a/app-api/README.md b/app-api/README.md
@@ -11,9 +11,14 @@ poetry install
 
 Check the [Set Up Additional Tools](https://github.com/iusztinpaul/energy-forecasting#-set-up-additional-tools-) and [Usage](https://github.com/iusztinpaul/energy-forecasting#usage) sections to see **how to set up** the **additional tools** and **credentials** you need to run this project.
 
+## Usage for Development
+
 To start the server, run the following:
 ```shell
 sh run.sh
 ```
 
 Access http://127.0.0.1:8001/api/v1/docs to see the docs.
+
+
+Check out this [Medium article](placeholder-medium-article) for more details about this module.
diff --git a/app-frontend/README.md b/app-frontend/README.md
@@ -11,9 +11,14 @@ poetry install
 
 **NOTE:** Be sure that the API is already running.
 
+
+## Usage for Development
+
 To start the app, run the following:
 ```shell
 streamlit run frontend/main.py --server.port 8501
 ```
 
 Access http://127.0.0.1:8501/ to see the app.
+
+Check out this [Medium article](placeholder-medium-article) for more details about this module.
diff --git a/app-monitoring/README.md b/app-monitoring/README.md
@@ -11,9 +11,14 @@ poetry install
 
 **NOTE:** Be sure that the API is already running.
 
+
+## Usage for Development
+
 To start the app, run the following:
 ```shell
 streamlit run monitoring/main.py --server.port 8502
 ```
 
 Access http://127.0.0.1:8502/ to see the app.
+
+Check out this [Medium article](placeholder-medium-article) for more details about this module.
diff --git a/batch-prediction-pipeline/README.md b/batch-prediction-pipeline/README.md
@@ -35,4 +35,4 @@ python -m batch_prediction_pipeline.monitoring
 
 Check out this [Medium article](placeholder-medium-article) for more details about this module.
 
-**NOTE:** Be careful to set the `ML_PIPELINE_ROOT_DIR` variable as explain in this [section](https://github.com/iusztinpaul/energy-forecasting#set-up-the-ml_pipeline_root_dir-variable).
+**NOTE:** Be careful to set the `ML_PIPELINE_ROOT_DIR` variable as explained in this [section](https://github.com/iusztinpaul/energy-forecasting#set-up-the-ml_pipeline_root_dir-variable).
diff --git a/feature-pipeline/README.md b/feature-pipeline/README.md
@@ -25,3 +25,5 @@ python -m feature_pipeline.feature_view
 ```
 
 Check out this [Medium article](https://medium.com/towards-data-science/a-framework-for-building-a-production-ready-feature-engineering-pipeline-f0b29609b20f) for more details about this module.
+
+**NOTE:** Be careful to set the `ML_PIPELINE_ROOT_DIR` variable as explained in this [section](https://github.com/iusztinpaul/energy-forecasting#set-up-the-ml_pipeline_root_dir-variable).
diff --git a/images/airflow_ml_pipeline_dag_overview_screenshot.png b/images/airflow_ml_pipeline_dag_overview_screenshot.png
diff --git a/images/airflow_ml_pipeline_dag_screenshot.png b/images/airflow_ml_pipeline_dag_screenshot.png
diff --git a/training-pipeline/README.md b/training-pipeline/README.md
@@ -29,3 +29,6 @@ python -m training_pipeline.train
 ```
 
 Check out this [Medium article](placeholder-medium-article) for more details about this module.
+
+
+**NOTE:** Be careful to set the `ML_PIPELINE_ROOT_DIR` variable as explain in this [section](https://github.com/iusztinpaul/energy-forecasting#set-up-the-ml_pipeline_root_dir-variable).