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

Fix typos in Readme.md #598

Merged
merged 4 commits into from
Dec 4, 2023
Merged

Fix typos in Readme.md #598

merged 4 commits into from
Dec 4, 2023

Conversation

anddann
Copy link
Contributor

@anddann anddann commented Nov 14, 2023

  • Fixed typo maven plugin version 3.2.5
  • Fixed typo start-steady.sh vs setup-steady.sh

TODOs

  • Tests on local machine
  • Documentation

@henrikplate
Copy link
Contributor

henrikplate commented Nov 14, 2023

Hello @anddann - Both scripts docker/start-steady.sh and docker/setup-steady.sh do exist, and the latter actually downloads and calls the former. Maybe we change the text to the following:

[...] triggered by `setup-steady.sh` or directly using `start-steady.sh -s ui`[...]

@anddann
Copy link
Contributor Author

anddann commented Nov 15, 2023

Sry, @henrikplate you are absolutely right. I've just downloaded the setup-steady.sh file and did not find the start-steady.sh file in the folder, and thus assumed that it does not exist. However, I know found it in steady-3.2.5/start-steady.sh

README.md Outdated
@@ -41,15 +41,15 @@ This section provides the bare minimum to setup Steady and to use its Maven plug

**Notes**:
- Tested with Docker 20.10.11 + Docker Compose 1.29.2 on Intel Macs with macOS 12.3.1, and Docker 20.10.15 + Docker Compose 1.29.0 on Ubuntu 20.04.4 and 18.04.6.
- During its first execution, triggered by the setup script or directly using `start-steady.sh -s ui`, the backend will be bootstrapped by downloading and processing code-level information of hundreds of vulnerabilities maintained in the open-source knowledge base [Project KB](https://github.com/sap/project-kb). While the bootstrapping can take up to two hours, later updates will import the delta on a daily basis. Run `start-steady.sh -s none` to shut down all Docker Compose services of the backend.
- During its first execution, triggered by the setup script triggered by `setup-steady.sh` or directly using `start-steady.sh -s ui`, the backend will be bootstrapped by downloading and processing code-level information of hundreds of vulnerabilities maintained in the open-source knowledge base [Project KB](https://github.com/sap/project-kb). While the bootstrapping can take up to two hours, later updates will import the delta on a daily basis. Run `start-steady.sh -s none` to shut down all Docker Compose services of the backend.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the redundant triggered by, and we're all good ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed, sry for the delay!

Copy link
Contributor

@henrikplate henrikplate left a comment

Choose a reason for hiding this comment

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

Please see the comment regardin README.md...

@henrikplate henrikplate merged commit 8c216f1 into eclipse:master Dec 4, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants