hyperledger-archives / sawtooth-docs-archive

Source files for the Hyperledger Sawtooth website

Hyperledger Sawtooth

This project has moved (see below).

Hyperledger Sawtooth was a project to provide an enterprise solution for building, deploying, and running distributed ledgers (also called blockchains).

Project Status

This Hyperledger project, Hyperledger Sawtooth, has been archived and is no longer active within Hyperledger.

Sawtooth is now maintained by the Splinter community. For more information, visit: https://github.com/splintercommunity/sawtooth-core/

License

Hyperledger Sawtooth software is licensed under the Apache License Version 2.0 software license.

sawtooth-docs-archive's Issues

Broken link in docs guide for "app_developers_guide/no_sdk"

Hello Sawtooth team, I was reading the documentation and went to the version 1.1 to see some changes in it.

After some searching found that this page has a broken link for the tutorial.

It shows like this:

• ../_autogen/txn_submit_tutorial

But I think it should show the documentation that you already have for that version which is in one of your repositories here: https://github.com/hyperledger/sawtooth-docs/blob/main/docs/core/1.1/_templates/txn_submit_tutorial.md.

If the current behavior was intended please ignore this issue, else I would recommend you to fix that part to keep the docs website a little bit better.

Incorrect REST API Specs for "/blocks"

https://sawtooth.hyperledger.org/docs/1.2/rest_api/openapi/#/paths/~1blocks/get

In the above specs, '/blocks' response specified, block_num as integer. But it is coming as string. Please fix the documentation.

{
"header": {
"block_num": "2",
"previous_block_id": "b05a7f41b0c15a4b0eaaf14397ef346b84bbc0e2d6240d7e189ce711cbda79a12ce3aaf8b1e51bdd1deaad6ce04a5bddcd0a11387b87fed9b2a49fe67c38609e",
"signer_public_key": "0354a24f9e1a981fe3924c7c36fb1e7f4612e0c896525203bcf50046d868c4af9a",

Broken links to Kuberentes test network deployment yaml

Hello. In the app developers guild - creating sawtooth network - Kubernetes - step 3, the yaml files links leads to dead ends.

sawtooth-kubernetes-default-pbft.yaml

sawtooth-kubernetes-default-poet.yaml

The files I think are in the core repo:

https://github.com/hyperledger/sawtooth-core/tree/main/docker/kubernetes

I thought of opening a PR but there are other yaml files there. Not sure if replacing the links would be sufficient for your intent in the docs.

Thank you

Empty files: missing content?

There are some empty files in our documentation, e.g.,

$ find docs/1.2 -type f -empty -name \*.md | wc -l
13

Some of these may await writing. Other documents link to some of these, e.g., @suchapalaver noticed that this link fails:

$ grep sysadmin docs/1.2/index.md 
[Sysadmin Guide]({% link docs/1.2/sysadmin_guide/index.md %})
$ ls -l docs/1.2/sysadmin_guide/index.md
-rw-rw-r-- 1 mtbc mtbc 0 Jul 10 11:15 docs/1.2/sysadmin_guide/index.md

Handle mentions of Raft

Raft needs deemphasizing, at the least. Current mentions are:

FAQ:

• Consensus Algorithms
• Validator
• Configuration Settings
• Sawtooth Videos
• Sawtooth Glossary

V1.2 Documentation:

• Introduction
• Dynamic Consensus
• Glossary

Comments on this issue capture our determining an action plan.

Generate full documentation from Open API Spec

docs: HTTP 404 Digital Asset Exchange Read The Docs

Go here:
https://sawtooth.hyperledger.org/examples/marketplace.html

Then click on Read the Docs which will take you to here (dead):
https://intelledger.github.io/0.7/mktnav_users_guide.html