search

hyperledger / indy-node

The server portion of a distributed ledger purpose-built for decentralized identity.
https://wiki.hyperledger.org/display/indy
Apache License 2.0
685 stars 657 forks source link

Documentation Updates #1814

Open pSchlarb opened 1 year ago

pSchlarb commented 1 year ago

Cherry picked the New Network from Scratch documentation, updated the indy-cli references to include indy-cli-rs and fixed the Python3.5 reference as pointed out in https://github.com/hyperledger/indy-node/pull/1811.

Feel free to make changes to this PR, which is open for edits.

WadeBarnes commented 1 year ago

@lynnbendixsen, Could you review the documentation please. Focusing on docs/source/configuring-2nics.md and docs/source/installation-and-configuration.md since the configuration of the NICs is different on Ubuntu 20.04 and the package installation for 20.04 requires a few more steps at the moment.

WadeBarnes commented 1 year ago

@pSchlarb, I think we should switch to indy-cli-rs as the recommended cli if not using the containerized one from von-network.

pSchlarb commented 1 year ago

Yeah sure I can change it, but I would walk through it myself first to see if it works. Not sure if I can finish that before tomorrows contributors call.

WadeBarnes commented 1 year ago

Yeah sure I can change it, but I would walk through it myself first to see if it works. Not sure if I can finish that before todays contributors call.

You'll find the installation is a bit different.

pSchlarb commented 1 year ago

Just testet the documentation with indy-cli-rs it works fine. Should the old indy-cli install be deleted from the docs in all and only reference indy-cli-rs or bundled von network?

WadeBarnes commented 1 year ago

Just testet the documentation with indy-cli-rs it works fine. Should the old indy-cli install be deleted from the docs in all and only reference indy-cli-rs or bundled von network?

Yes, you can remove the references to the indy-sdk based version of the indy-cli and just leave the indy-cli-rs and von-network references.

swcurran commented 1 year ago

@WadeBarnes — leaving this to merge for you. Looks good, but I didn’t walk through it...

WadeBarnes commented 6 months ago

@lynnbendixsen, Could you have a look at the NIC configuration and update it as needed for Ubuntu 20.04 (to use netplan)?

lynnbendixsen commented 6 months ago

I am wondering if it's best to remove the "configuring-2nics.md" file, or maybe shortening it to just include a single line like 'To configure 2 nics refer to the platform specific instructions included as part of the *-NodeInstall-20.04.md documents included in the indy-node/docs/source/install-docs directory'] Reasoning: The configuring-2nics file focuses on AWS instructions only All relevant instructions for each of the other platforms is already written and included in the referenced documents. Thoughts? EDIT: The same as the above is likely true for the "installation-and-configuration.md" document. I have checked in a "validator-prep-20.04.md" document to the same director (install-docs).
Apologies for not seeing that documents already existed and then using those when I added the install documents last year. My bad. I will keep looking through the docs and see what can be done to either use, merge, or adjust these previously made documents to make it so that all is coherent. At least a master document is still needed (probably use installation-and-configuration.md?) that can guide newcomers through the process and link to the documents needed for each platform.

WadeBarnes commented 6 months ago

Yes, take advantage of the additional documentation and reference it.