From 936e0f4eff57e17e7a3216a178e49c86d1090ccf Mon Sep 17 00:00:00 2001 From: Veer0x1 Date: Thu, 2 Jan 2025 23:01:06 +0530 Subject: [PATCH] corrected the caliper documentation link Signed-off-by: Veer0x1 --- CONTRIBUTING.md | 2 +- docs/source/getting-started/installing-caliper.md | 2 +- docs/source/tutorial/fabric.md | 6 ++++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c9b8f584..c58654734 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/docs/source/getting-started/installing-caliper.md b/docs/source/getting-started/installing-caliper.md index 17b3d73b1..8928befa8 100644 --- a/docs/source/getting-started/installing-caliper.md +++ b/docs/source/getting-started/installing-caliper.md @@ -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. diff --git a/docs/source/tutorial/fabric.md b/docs/source/tutorial/fabric.md index 36e8ea028..c134ce8dc 100644 --- a/docs/source/tutorial/fabric.md +++ b/docs/source/tutorial/fabric.md @@ -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 @@ -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