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

corrected the caliper documentation link #1673

Merged
merged 1 commit into from
Jan 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This guideline intends to make contribtuions to Caliper easier by:

If you have further suggestions about improving the guideline, then you can follow the presented workflow to make your contribution.

Jump to [Contributing documentation](https://hyperledger-caliper.github.io/caliper/v0.6.0/contributing) to get started on your journey.
Jump to [Contributing documentation](https://hyperledger-caliper.github.io/caliper/0.6.0/getting-started/contributing/) to get started on your journey.
2 changes: 1 addition & 1 deletion docs/source/getting-started/installing-caliper.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ It is possible to skip, or perform only one of the above phases through use of t
Caliper is published as the [@hyperledger/caliper-cli](https://www.npmjs.com/package/@hyperledger/caliper-cli) NPM package, providing a single point of install for every supported adapter.

### Versioning semantics
Before explaining the steps for installing Caliper, let’s take a look at the `Versions` page of the CLI package. You will see a list of tags and versions. If you are new to NPM, think of versions as immutable pointers to a specific version (duh) of the source code, while tags are mutable pointers to a specific version. So tags can change where they point to. Easy, right?
Before explaining the steps for installing Caliper, let’s take a look at the [versions](https://www.npmjs.com/package/@hyperledger/caliper-cli?activeTab=versions) page of the CLI package. You will see a list of tags and versions. If you are new to NPM, think of versions as immutable pointers to a specific version (duh) of the source code, while tags are mutable pointers to a specific version. So tags can change where they point to. Easy, right?

But why is all this important to you? Because Caliper is still in its pre-release life-cycle (< v1.0.0), meaning that even minor version bumps are allowed to introduce breaking changes. And if you use Caliper in your project, you might run into some surprises depending on how you install Caliper from time to time.

Expand Down
6 changes: 4 additions & 2 deletions docs/source/tutorial/fabric.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Ensure you have the following pre-reqs installed

- docker engine or docker desktop
- curl
- jq
- [jq](https://jqlang.github.io/jq/)
- a supported node LTS version. a list current supported LTS versions can be found on the [node.js website](https://nodejs.org/) (to install node easily you can use the nvm tool found [here](https://github.com/nvm-sh/nvm))

```sh
Expand Down Expand Up @@ -499,7 +499,9 @@ Ensure that you are in the **caliper-workspace** directory.

In the terminal run the following Caliper CLI command:

`npx caliper launch manager --caliper-workspace ./ --caliper-networkconfig networks/networkConfig.yaml --caliper-benchconfig benchmarks/myAssetBenchmark.yaml --caliper-flow-only-test`
```sh
npx caliper launch manager --caliper-workspace ./ --caliper-networkconfig networks/networkConfig.yaml --caliper-benchconfig benchmarks/myAssetBenchmark.yaml --caliper-flow-only-test
```

### Benchmark Results

Expand Down
Loading