Update documentation --> more detailed / structured README for startup
ToDos:
-
Restructuring the documentation to be easier to use -
generally implement Feedback from Martin -
possibly use service like https://readthedocs.org
to improve readability
Restructuring the documentation
- Title and description
- Table of contents:
- Installation
- Different ways to start it
- Frameworks needed to run it (maybe link to "developer onboarding?)
- Ways to start it
- Quick one line of code
- Different docker compose combinations
- Mtls, no mtls, mock server, etc..
- Dev mode
- Different ways to start it
- Devolper Onboarding
- Which configuration is needed?
- To run it
- JAVA Version
- Docker / Rancher docker version
- Etc. …
- For development
- Quarkus?
- Etc…
- To run it
- Which configuration is needed?
- How to configure it
- Different configurations
- How to setup pub/sub (notifications)
- How patch works
- Standard auto accept request? Via mock server?
Feedback Martin:
-
Great to have .sdkmanrc available, nevertheless it would be helpful to include the info that for non-SDKMAN user JAVA 17 is required.
-
After executing
./mvnw compile quarkus:dev
like in the README the next problem occurs:
[io.qua.run.uti.ContainerRuntimeUtil]
(main) Command "docker" exited with error code 1. Rootless container runtime detection might not be reliable.
--> Better to include the info that docker is needed
- Next problem:
`One or more configuration errors have prevented the application from starting. The errors are:
- SRCFG00014: The config property quarkus.mockserver.host is required but it could not be found in any config source
- SRCFG00014: The config property quarkus.mockserver.port is required but it could not be found in any config source
- SRCFG00014: The config property quarkus.mockserver.endpoint is required but it could not be found in any config source
- SRCFG00014: The config property quarkus.mockserver.client.host is required but it could not be found in any config source
- SRCFG00014: The config property quarkus.mockserver.client.port is required but it could not be found in any config source `
--> more detailed description is needed to help here.
Problem:
https://quarkiverse.github.io/quarkiverse-docs/quarkus-mockserver/dev/index.html
--> here it states that default values exist, how ever this is rather irritating.