search

hyperledger-caliper / caliper

A blockchain benchmark framework to measure performance of multiple blockchain solutions https://wiki.hyperledger.org/display/caliper
https://hyperledger-caliper.github.io/caliper/
Apache License 2.0
654 stars 404 forks source link

Docs reference themselves for more information which is a bit pointless #1648

Open davidkel opened 3 weeks ago

davidkel commented 3 weeks ago

In docs/source/getting-started/installing-caliper.md it has the statement

For more information on Hyperledger Caliper: https://hyperledger-caliper.github.io/caliper/

which is pointless, we should remove it

docs/source/tutorial/fabric.md

You have successfully benchmarked a smart contract. You can repeat the test varying the benchmark parameters, as well as adding resource monitors. For the full set of options, please refer to the [Caliper Documentation](https://hyperledger-caliper.github.io/caliper/)

should reference the relative location in the docs, not the url for caliper documentation

as a side json-schema/hyperledger-caliper-runtime-configuration.schema.json provides links which will become invalid once the new docs are released

argbet21 commented 3 weeks ago

Regarding docs/source/tutorial/fabric.md: I couldn't find the homepage (https://hyperledger-caliper.github.io/caliper/) in the source code to reference. Shall I reference this page instead: https://hyperledger-caliper.github.io/caliper/v0.6.0/getting-started/? Or perhaps I'm missing something about where to locate the homepage?

Regarding json-schema/hyperledger-caliper-runtime-configuration.schema.json: Since this is a json file rather than an md file, I'm unsure how we could reference a documentation page here?

davidkel commented 6 days ago

Still need to fix the tutorial but that can be done in a new PR