bcgov / von-network

A portable development level Indy Node network.
Apache License 2.0
159 stars 188 forks source link

Update `./manage cli` documentation or functionality #269

Open WadeBarnes opened 1 year ago

WadeBarnes commented 1 year ago

The ./manage cli command no longer works as described in the Connecting to the Network section of the main readme.

Either update the documentation to reference the Using the containerized indy-cli, or modify the scripts so the command functions as described.

WadeBarnes commented 1 year ago

@swcurran, @esune, Any opinion on which option you'd like to see implemented?

swcurran commented 1 year ago

Given that ./manage is ubiquitous in von-network, my gut says to fix the scripts to make sense, and adjust the documentation if there is a gap.

If the other reference is complete and sufficient, then removing the “cli” section from ./manage would be the next minimum.

@WadeBarnes:

WadeBarnes commented 1 year ago

It would be nice to have a simplified startup process that works with any ledger, not just von-network. The previous functionality described by the documentation relied on the IP address to point to a von-network instance where it could infer the URL to the genesis file. So after thinking about this for a bit, it might not be appropriate to resurrect the documented functionality.

Updating the documentation would be the least amount of effort. Resurrecting the documented functionality would take an hour or so.

esune commented 1 year ago

If I got it right, I agree that updating the docs to use the newer/up-to-date method (containerized cli) is probably the best way forward.