-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md, introduce INSTALL.md #174
Update README.md, introduce INSTALL.md #174
Conversation
@DominikPinsel @borisrizov-zf @mknoopvw |
Kudos, SonarCloud Quality Gate passed! |
I tested the changes made in order to get started: it worked as described in |
🎉 This PR is included in version 0.2.0-develop.8 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
🎉 This PR is included in version 0.3.0-develop.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
🎉 This PR is included in version 0.3.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
References to catenax-ng is prohibited. INSTALL.md
is supposed to contain deployment information for productive use, not local test installations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- The reference is gone in the current release (0.3.0)
- The installation instructions for the Helm Chart - in my opinion that would be the productive deployment - are in the Helm Chart itself. So what should be there if not the local installation? If so, then a link to it would be enough and could be placed in the Readme.md. The Install.md would then be unnecessary...
Description
This PR updates updates content in the "Developer documentation" section and introduces INSTALL.md.
This file describes the actions needed, to just run MIW. Nothing else.
Beside that main purpose of the PR, there are some minor adjustments / fixes, which popped up during the verification of the README.md file.
This PR fixes #150
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: