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

docs: Include the required jq dependency #492

Merged
merged 4 commits into from
Mar 4, 2024

Conversation

medinad96
Copy link
Contributor

Motivation

Followed the quickstart and ran into "jq not found" when running the following command. Quickstart link

./scripts/install.sh --namespace modelmesh-serving --quickstart --enable-self-signed-ca

The following change made jq a necessary dependency:

# check if jq is installed
if [ ! -x "$(command -v jq)" ]; then
echo "jq not found"
exit 1

Modifications

Modified the list under the following link to point to where jq can be downloaded or installed https://github.com/kserve/modelmesh-serving/blob/main/docs/quickstart.md#prerequisites

Result

The prerequisites list has the link detailed below.

@rafvasq
Copy link
Member

rafvasq commented Mar 4, 2024

Thanks @medinad96! Can you please follow the instructions here to sign off your commit (DCO)?

Copy link
Member

@rafvasq rafvasq left a comment

Choose a reason for hiding this comment

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

I think you can also add a sentence to the end of this line explaining the self-signed script here and mention that jq is required for that script.

@rafvasq rafvasq changed the title Update quickstart documentation to include the required jq dependency docs: Include the required jq dependency Mar 4, 2024
docs/install/install-script.md Outdated Show resolved Hide resolved
docs/install/install-script.md Outdated Show resolved Hide resolved
docs/install/install-script.md Outdated Show resolved Hide resolved
Copy link

oss-prow-bot bot commented Mar 4, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: medinad96, rafvasq

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@oss-prow-bot oss-prow-bot bot added the approved label Mar 4, 2024
Copy link

oss-prow-bot bot commented Mar 4, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: medinad96, rafvasq

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@rafvasq
Copy link
Member

rafvasq commented Mar 4, 2024

/lgtm

@oss-prow-bot oss-prow-bot bot added the lgtm label Mar 4, 2024
@rafvasq rafvasq merged commit 1682254 into kserve:main Mar 4, 2024
3 checks passed
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.

2 participants