Skip to content
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

Merged
merged 6 commits into from
Nov 28, 2023
Merged

Update README.md, introduce INSTALL.md #174

merged 6 commits into from
Nov 28, 2023

Conversation

pmoscode
Copy link
Contributor

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:

@pmoscode
Copy link
Contributor Author

@DominikPinsel @borisrizov-zf @mknoopvw
It would be great, if you could verify the INSTALL.md.

Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@mknoopvw
Copy link
Contributor

I tested the changes made in order to get started: it worked as described in install.md.

@borisrizov-zf borisrizov-zf merged commit 47c4c38 into eclipse-tractusx:develop Nov 28, 2023
8 checks passed
Copy link

🎉 This PR is included in version 0.2.0-develop.8 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Dec 7, 2023

🎉 This PR is included in version 0.3.0-develop.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Dec 7, 2023

🎉 This PR is included in version 0.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. The reference is gone in the current release (0.3.0)
  2. 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...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants