uosnetwork / uos.docs Goto Github PK

Discrepancy in account name conventions

Summary

In Spinning up a Block Producer Node on Ubuntu documentation, in the chapter 8, is written that account name must start with a letter.
But the example indicates 123example345 that starts with a number.

Environment

NA

Steps to reproduce

NA

Expected result

Correct documentation.

Current result

NA

Possible Fix

"Must start with a letter" seems not accurate as 123example345 passes validation on u.community registration page.

Additional information

NA

Examples

NA

Errors in "Spinning up a Block Producer Node on Ubuntu" documentation

Summary

A command is missing.
Some script file can't be found.
Installation can't be done.

Environment

Ubuntu 16.04

Steps to reproduce

Follow instructions of the "Spinning up a Block Producer Node on Ubuntu" documentation.

Example:

• At step 4 (Update the submodules), you need to change folder before executing the git command:
  cd uos
• At step 5 (Build the U°OS software) eosio_build.sh can't be found
• At step 6 (Install the node): nodeos command not found
• At step 7 (Generate three key pairs): cleos command not found

Expected result

Correct documentation.

Current result

Unable to continue installation.

Possible Fix

• Step 4: Add cd uos
• Step 5: Replace by scripts/eosio_build.sh -s UOS
• Step 6 & 7: Add ~/opt/eosio/bin/ path before command

Additional information

NA

Examples

NA

Do a description of a Calc node:

– Role
– Requirements
– Consensus model
– Purpose
– What it does

etc

Maybe add a visual if necessary.

Publish to https://uos.readme.io/docs/calculator-node

Do a description of a Seed node:

– Role
– Requirements
– Purpose
– What it does

etc

Maybe add a visual if necessary.

Publish to https://uos.readme.io/docs/[create Seed Node section]

Commit lgpl 3.0 to the following repos:

uos.backend
ups.frontend
singularity

Leaning towards readme.io to be compatible with the EOSIO docs.

Do a description of a BP node:

– Role
– Requirements

etc

Maybe add a visual if necessary.

Publish to https://uos.readme.io/docs/block-producer-node

We'll need refs to EOSIO docs so as not duplicate what they maintain.

Dapp deployment walkthroughs
U°OS architecture
U°Community architecture
Two node types: BP and Calcs

On the architecture visualizations, it must be maintainable, but really not leaning towards UML.

Archimate would be good, but it's too time consuming for the reader.

As part of our ongoing efforts to bring the Yellow Paper up to date and make it digestible, we need to expand on and add the following sections:

– Abstract
– Introduction
– Motivation
– Previous work
– Algo description
– Plan architecture section

Error in yellow paper

There are the words "insert hyperlink here" instead of a hyperlink.

Summary

On page 17 in the footer, a placeholder is there instead of the correct link.

Environment

Github

Steps to reproduce

• Navigate to the yellow paper (https://github.com/UOSnetwork/uos.docs/blob/master/yellow_paper/uos_yellow_paper.eng.pdf)
• View footer on page 17

Expected result

A link instead of a place holder

Current result

Placeholder text

Draft an architecture overview of U°OS & U°Community.
Do a scheme / visual representation.

Publish at https://uos.readme.io/docs/architecture-overview

Do a description of a API node:

– Role
– Requirements
– Purpose
– What it does

etc

Maybe add a visual if necessary.

Publish to https://uos.readme.io/docs/[create API Node section]

Draft an FAQ to put on u.community

The yellow paper at https://github.com/UOSnetwork/uos.docs/tree/master/yellow_paper needs restructuring and must be updated with the latest information.

This issue specifically addresses a new structure proposal.

Draft a DPOI architecture overview.
Add a visual representation.
Publish to https://uos.readme.io/docs/delegated-proof-of-importance

New errors in "Spinning up a Block Producer Node on Ubuntu" documentation

Summary

In Spinning up a Block Producer Node on Ubuntu documentation, in the chapter 9, the Note concerning uncommented agent-name seems obsolete. In my case it was commented.

In chapter 13, you need first to unlock the wallet else the run command fails (in previous chapter you have to lock it).

Environment

Ubuntu 16.04

Steps to reproduce

Follow documentation instructions

Expected result

Correct documentation.

Current result

1. Useless note
2. run command fails with error:
   Error 3120003: Locked wallet Ensure that your wallet is unlocked before using it! Error Details: You don't have any unlocked wallet!

Possible Fix

1. Remove the useless note
2. Do not lock wallet in chapter 12 or add unlock wallet command in chapter 13

Additional information

NA

Examples

NA