Repository: provectus/kafka-ui
Issue: [docs] Update/fix documentation where needed
Labels: type/documentation
status/accepted

**Describe the bug**
After setting up my local dev environment, I've noticed some errors in the documentation. I'll go through and fix them in a PR; this issue is to track these errors.

Issue comments:
Hello there omh1280! 👋

Thank you and congratulations 🎉 for opening your very first issue in this project! 💖

In case you want to claim this issue, please comment down below! We will try to get back to you as soon as we can. 👀
Claim
@omh1280 Hey,

 sure, would be nice to get it updated.

Thanks
I also saw some documentation linking errors, this one for example:

https://github.com/provectus/kafka-ui/blob/ce8627ea59be60367c3d824375dd3feca6f8479a/README.md?plain=1#L72

Are you gonna fix those too? If not I could also contribute via PR

Yeah I'll fix that one and others in that PR ^. Just link or comment where else needs fixing

Pull request review comments:
Question for maintainers
Question for maintainers
Is there a way to pass a configuration to this command?

I tried this:
```bash
./mvnw clean spring-boot:run -Pprod -Dexec.args="src/main/resources/application-local.yml"
```
Hmm I thought I fixed this one
Yea, `local` and `generate-spring-webflux-api` are "non-prod" profiles :)
It should be possible indeed, but I'm not quite sure that we have required dependencies included to make that happen. Need to investigate in a separate issue.
Yes:
`spring.config.additional-location` to keep the default config in place and override values if required.
`spring.config.location` to use it as a default one.

Examples:
`--spring.config.location=file:///tmp/kafka-ui-conf.yml`
Ok, I see `local` but only for the e2e project. For developing on `kafka-ui-api` there is only prod, so maybe I'll clarify that in the docs
Oops. Yea, indeed, it's just for this module. So it's just `prod` for api module and openapi profile for contract module.
This would be really nice to have docs on!
Thanks for the review @Haarolean!

I tried this, to no luck. Any ideas?
```
 ./mvnw clean spring-boot:run -Pprod  -Dexec.args="--spring.config.location=file:///path/to/conf.yaml"  
```
Any ideas @Haarolean or anyone else? Would be nice to have this in the docs.
Sorry for the delay.
This should work:
` ./mvnw clean spring-boot:run -Pprod  -Dspring.config.location=file:///path/to/conf.yaml`
I'll create an issue to get this improved
Thanks! Updated
We've added a linter for links in .MD files, but it was misconfigured, that's why these got in.

Patch that resolved the issue:
diff --git a/README.md b/README.md
index 7a0f30e7731..fbf9eacdd8d 100644
--- a/README.md
+++ b/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
diff --git a/documentation/project/contributing/building.md b/documentation/project/contributing/building.md
index 37596be38fc..21562426e5e 100644
--- a/documentation/project/contributing/building.md
+++ b/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
 
diff --git a/documentation/project/contributing/running.md b/documentation/project/contributing/running.md
index aec09804d86..a74f198f0c1 100644
--- a/documentation/project/contributing/running.md
+++ b/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
diff --git a/documentation/project/contributing/software-required.md b/documentation/project/contributing/software-required.md
index dd3fa656c36..8d3b86c7311 100644
--- a/documentation/project/contributing/software-required.md
+++ b/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
\ No newline at end of file
diff --git a/kafka-ui-react-app/README.md b/kafka-ui-react-app/README.md
index 3eabe899264..43af77d4f5a 100644
--- a/kafka-ui-react-app/README.md
+++ b/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


Test patch: