Missing Runtime Information

[mhellmeier]

Bug Report

Describe the Bug

Currently, the documentation and the README lack essential information for deploying the Data Dashboard, including wrong commands, broken links, and spelling issues.

Expected Behavior

Some aspects currently missing the in the documentation:

• Requirements section. What is required to run the Data Dashboard (like docker, docker compose, Azure, etc.)?
• Compatible EDC version. Only by viewing the Commit history, it can be assumed with which version the dashboard is compatible.
• Information for variables. Currently, it isn't described how to run the data dashboard with a catalog and management API URL on different ports. Therefore, everything seems to run on 8181 and 9191.

Observed Behavior

Besides the missing information, there are different issues like wrong commands, broken links, or spelling bugs, making it harder to deploy the product. Some examples:

• Commands like git udpate-index --assume-unchanged src/assets/config/app.config.json don't work since it is git update-index instead of git udpate-index
• Searching for specific words doesn't work. For example, the tool is sometimes called "frontend", sometimes "frondend"
• Links like the how to contribute are causing a 404 error

Steps to Reproduce

Trying to deploy the Data Dashboard as described in the README.

Context Information

• Used version: Current documentation and README of the main branch