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 reference themselves for more information which is a bit pointless #1648

Open
davidkel opened this issue Oct 29, 2024 · 3 comments · Fixed by #1652
Open

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

davidkel opened this issue Oct 29, 2024 · 3 comments · Fixed by #1652
Labels
bug Something isn't working documentation Related to the documentation

Comments

@davidkel
Copy link
Contributor

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

@davidkel davidkel added the documentation Related to the documentation label Oct 29, 2024
@argbet21
Copy link
Contributor

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 davidkel added the bug Something isn't working label Nov 6, 2024
@psankhe28 psankhe28 mentioned this issue Nov 16, 2024
9 tasks
@davidkel davidkel linked a pull request Nov 16, 2024 that will close this issue
9 tasks
@davidkel davidkel reopened this Nov 16, 2024
@davidkel
Copy link
Contributor Author

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

@davidkel
Copy link
Contributor Author

last bit now
json-schema/hyperledger-caliper-runtime-configuration.schema.json
provides links which will become invalid once the new docs are released

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Related to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants