You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
jeromy-cannon opened this issue
Dec 3, 2024
· 0 comments
Assignees
Labels
Epic Lv2A body of work that can be broken down into specific tasks.P2Required to be completed in the assigned milestone, but may or may not impact release schedule.
Getting Started -> Readme, NOTE: each item below are sections within the Readme.md, also remove table of contents, and note that other sections have moved to their own pages
description
full documentation link
requirements / version chart
setup
install solo
setup k8s
quick start (previously "Setup Kubernetes cluster")( after the remote cluster and local cluster then provide the commands only to stand up a network with mirror node and json rpc relay, link them to the "Deploy a standalone test network" page, make this static, the dynamic part will move to another page)
support
contributing
code of conduct
licensing
Solo CLI -> an overview of the CLI tool, plus dynamic: solo --help, NOTE: each item below is a unique page
Init -> heading + dynamic solo init --help
Context -> heading, table of contents, + dynamic solo context --help, solo context connect --help
Deployment
Cluster -> heading, table of contents, + dynamic solo cluster --help, solo cluster list --help, solo cluster info --help, solo cluster setup --help, solo cluster reset --help
Network -> heading, table of contents, + dynamic solo network --help, solo network deploy --help, solo network destroy --help, solo network refresh --help
Node -> heading, table of contents, + dynamic solo node --help, go through each one.. there are a lot.
Mirror Node -> heading, table of contents, + dynamic solo mirror-node --help, solo mirror-node deploy --help, solo mirror-node destroy --help
Relay -> heading, table of contents, + dynamic solo relay --help, solo relay deploy --help, solo relay destroy --help
Account -> heading, table of contents, + dynamic solo account --help, solo account init --help, solo account create --help, solo account update --help, solo account get --help
Usage, NOTE: each item below is a unique page
Deploy a standalone test network (use section from current readme)
Access Hedera Network services (use section from current readme)
Logs (use section from current readme)
For Developers Working on Hedera Service Repo (use section from current readme)
For Developers Working on Platform core (use section from current readme)
Using IntelliJ remote debug with Solo (use section from current readme)
Instructions for using Solo with Hedera JavaScript SDK (existing)
Running latest with clone of repo and Taskfile (new)
Hardware Requirements (new) (3 nodes, mirror node, and relay: RAM >= 8GB + CPU >= 4 for cluster, maybe show screenshot using Docker Desktop like we use with these settings) (would be good to know what it requires to run just a single node network without mirror node or relay (minimum))
How to use Mirror Node (new) (Torfinn and Tim Schmidt would be good people to run this by or get input from)
Environment Variables (new) (document the environment variables exposed in constants.ts)
Contributing
Frequently Asked Questions, NOTE: each item below are sections within the FAQ
Differences between Solo and Local Node, TBD, ask Torfinn, he is working on something
Q: How can I avoid using genesis keys? A: solo account init to be ran anytime after solo node start
Q: Where can I find the default account keys? A: it is the genesis key well documented, (link it or paste it here)
Q: How do I get the key for an account? A: (give command to run and example output)
TypesScript Doc
Related Projects
The text was updated successfully, but these errors were encountered:
Epic Lv2A body of work that can be broken down into specific tasks.P2Required to be completed in the assigned milestone, but may or may not impact release schedule.
Tasks
solo --help
, NOTE: each item below is a unique pagesolo init --help
solo context --help
,solo context connect --help
solo cluster --help
,solo cluster list --help
,solo cluster info --help
,solo cluster setup --help
,solo cluster reset --help
solo network --help
,solo network deploy --help
,solo network destroy --help
,solo network refresh --help
solo node --help
, go through each one.. there are a lot.solo mirror-node --help
,solo mirror-node deploy --help
,solo mirror-node destroy --help
solo relay --help
,solo relay deploy --help
,solo relay destroy --help
solo account --help
,solo account init --help
,solo account create --help
,solo account update --help
,solo account get --help
solo account init
to be ran anytime aftersolo node start
The text was updated successfully, but these errors were encountered: