fix: update mkdocs content

Signed-off-by: K Siva Prasad Reddy <sivaprasadreddy.k@gmail.com>

Author: sivaprasadreddy

README.md

@@ -7,13 +7,3 @@ actionable insights on which features are most well-received by users.
 
 To learn more, visit https://feature-tracker.github.io/.
 
-## How to contribute?
-* Run the application and let us know if you face any issue
-* Review the code and add your review comments
-
-## Development Setup
-* Install Mkdocs https://www.mkdocs.org/#installation
-  * `pip install mkdocs`
-  * `pip install mkdocs-material`
-* Run locally: `mkdocs serve` and open http://127.0.0.1:8000/
-* Deploy Site to GH Pages : `mkdocs gh-deploy`

docs/index.md

@@ -12,6 +12,59 @@ You need to install the following software:
 * [IntelliJ IDEA](https://www.jetbrains.com/idea/)
 * [Taskfile](https://taskfile.dev/)
 
+## Application Architecture
+The feature tracker application is being developed following Microservices Architecture.
+This application has the following services:
+
+* **feature-service**: Manages products, features, releases. [See more](https://github.com/feature-tracker/feature-service/blob/main/README.md)
+* **user-service**: Manages users by interacting with Keycloak. [See more](https://github.com/feature-tracker/user-service/blob/main/README.md)
+* **notification-service**: Handles events published by other services and sends notification emails. [See more](https://github.com/feature-tracker/notification-service/blob/main/README.md)
+* **config-server**: Central Config server to store all the microservices configuration. [See more](https://github.com/feature-tracker/config-server/blob/main/README.md)
+* **api-gateway**: API Gateway to store all the microservices. [See more](https://github.com/feature-tracker/api-gateway/blob/main/README.md)
+* **feature-tracker-angular**: Frontend SPA for feature-tracker application. [See more](https://github.com/feature-tracker/feature-tracker-angular/blob/main/README.md)
+
+## Getting Started
+The application components are published as Docker images on DockerHub.
+The Keycloak Identity Management System is used as an OAuth 2.0 server to secure the application.
+
+
+> **IMPORTANT:**
+> 
+> Frontend application uses front-channel to login with Keycloak.
+> Backend microservices uses back-channel to validate auth tokens.
+> 
+> To use the same host name for both scenarios, 
+> add the host name `keycloak` to `/etc/hosts` file pointing to `127.0.0.1`.
+>
+> ```shell
+> 127.0.0.1   keycloak
+> ```
+>
+
+[Task](https://taskfile.dev/) is a task runner that we can use to run any arbitrary commands in an easier way.
+
+Install [Task CLI](https://taskfile.dev/installation/).
+
+```shell
+$ brew install go-task
+(or)
+$ go install github.com/go-task/task/v3/cmd/task@latest
+
+#verify task version
+$ task --version
+Task version: 3.35.1
+```
+
+Now, you can run the application locally using docker-compose as follows:
+
+```shell
+$ git clone https://github.com/feature-tracker/docker-infra.git
+$ cd docker-infra
+$ task start
+```
+
+You can access the Feature Tracker application at http://localhost:4200
+
 ## Local Development
 
 **1.Clone the repositories**
@@ -26,24 +79,17 @@ $ git clone https://github.com/feature-tracker/user-service.git
 $ git clone https://github.com/feature-tracker/feature-tracker-angular.git
 ```
 
-**2.Start all the required services(Keycloak, databases, message brokers, etc.)**
+**2. Build Docker images of all the components**
 
 ```shell
 $ cd docker-infra
-$ task start_infra
+$ ./local-build.sh
 ```
 
-**IMPORTANT:** Add the host name `keycloak` to `/etc/hosts` file pointing to `127.0.0.1`.
+**3.Start the entire application**
 
-```shell
-127.0.0.1   keycloak
-```
-
-**3.Run backend microservices.**
-
-You can run the individual microservices from the IDE. 
-
-Alternatively, you can start all the microservices and their dependent services using Docker by running the following command:
+You can start all the components of the system and their dependent services(Keycloak, databases, message brokers, etc.) 
+using Docker Compose by running the following command:
 
 ```shell
 $ task start
@@ -55,7 +101,20 @@ Examples:
 
 * `curl http://localhost:8989/features/api/products`
 
-You can access the Feature Tracker Angular application at http://localhost:4200
+You can access the Feature Tracker application at http://localhost:4200
+
+**4.Debugging/Running Microservices from IDE**
+
+You may want to start the infra components as Docker containers and run specific microservice from IDE.
+
+In that case, start all the infra components(Keycloak, databases, message brokers, etc.) as follows:
+
+```shell
+$ cd docker-infra
+$ task start_infra
+```
+
+Now, you can run the individual microservices from the IDE.
 
 ## How to contribute?
 * Run the application and let us know if you face any issue

mkdocs-setup.md

@@ -0,0 +1,6 @@
+# Mkdocs Setup
+* Install Mkdocs https://www.mkdocs.org/#installation
+    * `pip install mkdocs`
+    * `pip install mkdocs-material`
+* Run locally: `mkdocs serve` and open http://127.0.0.1:8000/
+* Deploy Site to GH Pages : `mkdocs gh-deploy`