Feature/393 readme improvements #456
Conversation
…he IRS?" to new section "Introduction"
…Getting in Touch" section in the README.md
…he project" - link to discussion page concering documentation improvements - link to inbox,backlog items labeled as documntation
…e easier diff with main
- use relative link to NOTICE.md - add link to IRS LICENSE file
…and "Contributing" (with link to CONTRIBUTING.md)
We track these remaining TODOs in the story on github.
…AUTHORS.md (because this information is referenced from multiple places)
…OG entries as discussed in parking lot 2024-03-01
Sync with upstream
# Conflicts: # docs/src/docs/arc42/glossary.adoc
…m into separate columns
|
|
||
| ## Prerequisites | ||
|
|
||
| - Kubernetes 1.19+ | ||
| - Helm 3.2.0+ | ||
| - [Kubernetes](https://kubernetes.io) 1.19+ |
There was a problem hiding this comment.
Please remove version information here - therefor the compatibility matrix and the project is used. This might be outdated soon.
There was a problem hiding this comment.
Hi @mkanal, the versions were already there. I just added a link to the websites. Furthermore, currently the COMPATIBILITY_MATRIX.md does not include helm and kubernetes.
There was a problem hiding this comment.
So my recommendation would be to add this to the COMPATIBILITY_MATRIX.md and delete it here
There was a problem hiding this comment.
Prerequisites in the chart README are required by TRG 5.02. Do not remove it from here.
I'm not sure if we should add this to the compatibility matrix since that is a requirement for the IRS Helm Chart and not for the IRS application in general
| - Kubernetes 1.19+ | ||
| - Helm 3.2.0+ | ||
| - [Kubernetes](https://kubernetes.io) 1.19+ | ||
| - [Helm](https://helm.sh) 3.2.0+ |
There was a problem hiding this comment.
Please remove version information here - therefor the compatibility matrix and the project is used. This might be outdated soon.
There was a problem hiding this comment.
Could you point me to the answer, please.
| If you build the IRS yourself, you can modify the application.yml config that is shipped with the IRS. | ||
| This file contains all possible config entries for the application. | ||
| Once the Docker image has been built, these values can only be overwritten using the | ||
| https://docs.spring.io/spring-boot/docs/3.1.9/reference/htmlsingle/#features.external-config[Spring external config mechanism], |
There was a problem hiding this comment.
O would not recommend to use versions in this abstract here
There was a problem hiding this comment.
Hi @mkanal, I stumbeled over this too. The path changed between versions in the past - not only the version number, which is why we cannot update automatically using resource filtering. We would have to remove the link completely if we do not want to include a version here, which is not a good idea IMHO because then this information would be hard to find for people that are not so familiar with Spring Boot yet. As the mechanism of external config is pretty stable over the versions I think it is better to have a link to an old version here (if we forget to update) than to remove it completely.
There was a problem hiding this comment.
IMHO a generic info that we are using spring boot configuration is enough we do not have to point to the documentation. Spring Boot is well known and any developer could find the corresponding documentation istnt it the case?
There was a problem hiding this comment.
For my part and currently contributing colleagues this is probably true. But maybe not for future contributors. As the relevant section of the documentation can be found by searching for "spring boot externalized configuration" in search engines it may be ok to remove the link.
| @@ -0,0 +1,48 @@ | |||
| [[Back to main README](../../../README.md)] | |||
as suggested by mkanal in review https://github.com/eclipse-tractusx/item-relationship-service/pull/456/files#r1511340553
based on comment from ds-jhartmann https://github.com/eclipse-tractusx/item-relationship-service/pull/456/files#r1511381420
as suggested by ds-jhartmann in https://github.com/eclipse-tractusx/item-relationship-service/pull/456/files#r1511369743
Co-authored-by: ds-mkanal <100209308+mkanal@users.noreply.github.com>
… into chore/393_readme_improvements
Description
Improved documentation (for a detailed description of what has changed see outcome in #393)
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: