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

doc: fix miss install tools #19057

Closed

Conversation

camilesing
Copy link
Contributor

@camilesing camilesing commented Oct 22, 2024

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

see: #19054

its confuse when building mbook report error like 'cannot find command binstall '. i think the RisingWave Developer guide need to add install binstall command.

The command reference comes from here: https://github.com/cargo-bins/cargo-binstall

What's changed and what's your intention?

Checklist

  • I have written necessary rustdoc comments
  • I have added necessary unit tests and integration tests
  • I have added test labels as necessary. See details.
  • I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
  • My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
  • All checks passed in ./risedev check (or alias, ./risedev c)
  • My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
  • My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

  • My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

Copy link
Member

@xxchan xxchan left a comment

Choose a reason for hiding this comment

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

cargo-binstall will be installed by risedev, so I don't think we need to mention it in developer guide

risingwave/risedev

Lines 3 to 6 in 90d1fab

if [ -z "$(which cargo-binstall)" ] && [ -z "$RISINGWAVE_CI" ]; then
echo "Installing cargo-binstall..."
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
fi

@camilesing
Copy link
Contributor Author

cargo-binstall will be installed by risedev, so I don't think we need to mention it in developer guide

risingwave/risedev

Lines 3 to 6 in 90d1fab

if [ -z "$(which cargo-binstall)" ] && [ -z "$RISINGWAVE_CI" ]; then
echo "Installing cargo-binstall..."
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
fi

ok. now i know that i need to compile the project first before to do this

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