Update documentation; fix links (provectus#1603)

* closes 1602

* readme

* fixes

* docs

Co-authored-by: Roman Zabaluev <[email protected]>

Author: ottaviohartman

README.md

@@ -69,7 +69,7 @@ We have plenty of [docker-compose files](documentation/compose/DOCKER_COMPOSE.md
 
 - [SSO configuration](documentation/guides/SSO.md)
 - [AWS IAM configuration](documentation/guides/AWS_IAM.md)
-- [Docker-compose files](documentation/guides/yaml-description.md)
+- [Docker-compose files](documentation/compose/DOCKER_COMPOSE.md)
 - [Connection to a secure broker]()
 
 ## Connecting to a Secure Broker

documentation/project/contributing/building.md

@@ -8,15 +8,16 @@ Build a docker container with the app:
 ``` 
 Start the app with Kafka clusters:
 ```sh
-docker-compose -f ./docker/kafka-ui.yaml up -d
+docker-compose -f ./documentation/compose/kafka-ui.yaml up -d
 ``` 
 To see the app, navigate to http://localhost:8080.
 
-If you want to start only kafka clusters (to run the app via `boot:run`):
+If you want to start only kafka clusters (to run the app via `spring-boot:run`):
 ```sh
-docker-compose -f ./docker/kafka-clusters-only.yaml up -d
+docker-compose -f ./documentation/compose/kafka-clusters-only.yaml up -d
 ``` 
-Then start the app with a **local** profile. 
+
+Then, start the app.
 
 ## Where to go next
 

documentation/project/contributing/running.md

@@ -3,14 +3,18 @@
 ### Running locally via docker
 If you have built a container locally or wish to run a public one you could bring everything up like this:
 ```shell
-docker-compose -f docker/kafka-ui.yaml up -d
+docker-compose -f documentation/compose/kafka-ui.yaml up -d
 ```
 
 ### Running locally without docker
-Once you built the app, run the following:
+Once you built the app, run the following in `kafka-ui-api/`:
 
 ```sh
 ./mvnw spring-boot:run -Pprod
+
+# or
+
+./mvnw spring-boot:run -Pprod -Dspring.config.location=file:///path/to/conf.yaml
 ```
 
 ### Running in kubernetes

documentation/project/contributing/software-required.md

@@ -29,4 +29,3 @@ Otherwise, some apps within a stack (e.g. `kafka-ui.yaml`) might crash.
 ## Where to go next
 
 In the next section, you'll [learn how to build the application](building.md).
-### GIT SETUP

kafka-ui-react-app/README.md

@@ -54,7 +54,7 @@ Have to be run from root directory.
 
 Start UI for Apache Kafka with your Kafka clusters:
 ```sh
-docker-compose -f ./docker/kafka-ui.yaml up
+docker-compose -f ./documentation/compose/kafka-ui.yaml up
 ```
 
 Make sure that none of the `.env*` files contain `DEV_PROXY` variable