Cardano Relay Configuration: startTestNode.sh not portable, instructions incomplete

[dcow0]

While following the instructions for configuring a testnet node I found the startTestNode.sh script had the following problems.

• is not clear that the user should replace $HOME by its actual value on the script. This is clear for the cardano-testnode.service file, but I believe isn't for the script since is mentioned in the context of the latter.
• by following the instructions you get the file $HOME/.local/bin/cardano-node but not /usr/local/bin/cardano-node, which is what the script relies on. There should be a step where the user is told to set up /usr/local/bin/cardano-node or instead that line could be changed by $HOME/.local/bin/cardano-node
• While running the script I got the error error while loading shared libraries: libsecp256k1.so.0: cannot open shared object file: which was caused by the LD_LIBRARY_PATH and PKG_CONFIG_PATH variables not being properly set, since running the systemctl unit has no access to $HOME/.bashrc where it is actually configured by following the instructions. My solution was to set them in the script with the same values it has on $HOME/.bashrc
• Also got the following error running the script Conway related : There was an error reading the genesis file: $HOME/cardano-testnet/conway-genesis.json Error: $HOME/cardano-testnet/conway-genesis.json: openBinaryFile: does not exist (No such file or directory). My solution was doing curl -O -J https://book.world.dev.cardano.org/environments/preprod/conway-genesis.json

[rphair]

@der-robot I can also see this script is inadequate but from my own experience (never really having used the testnet) I'd not be a good person to write a PR submitting the right changes.

@katomm @fill-the-fill @rdlrt @os11k I think we should keep this open until editors and/or contributors agree upon a lowest common denominator of changes to both the script & instructions to set up for running it. I'd contribute to this discussion but I'd not be the right person to formulate that PR... being inclined simply to add a sentence saying "this script is just a guideline & needs modification according to your environment" which might not be enough for testnet target audiences. 🤔

[rdlrt]

I think "Installing Node" under Operate a Stake Pool should simply be a hyperlink to Installing Cardano Node and not be duplicated, as it increases number of places to maintain, and increases scope for mistakes/outdated links - alongwith keeping filesystem reference consistent

[sanskys]

while writing i did test it on a clean system. But it was a long documentation and so could be improved now. Will look into it in the coming weeks.

[sanskys]

I have updated the documentation and fixed 1,2 & 4.
Issue 3 cannot be reproduced. Did you use "systemctl" or "sudo systemctl"?

[rphair]

thanks @sanskys for your attention to this issue, but what would you think of just dropping these divergent explanations as @rdlrt suggested earlier in #1140 (comment)?

I've also reaffirmed this alternate suggestion in response to your changes in #1162 (review) (in the interest of maintainability & not including too many subjective elements in the installation).

[rdlrt]

Ye - I think the mentioned change should be in startTestNode.sh contents - to align with doco - not surrounding doco to align with that file, it could make use of variable at the beginning if folks want to change the path to binary, but using /usr/local/bin or /usr/local should not be default on development/learning modules.

[sanskys]

thanks @sanskys for your attention to this issue, but what would you think of just dropping these divergent explanations as @rdlrt suggested earlier in #1140 (comment)?

I've also reaffirmed this alternate suggestion in response to your changes in #1162 (review) (in the interest of maintainability & not including too many subjective elements in the installation).

@rphair @rdlrt Thanks for your feedback. I think it is a question of how the developer portal should be setup. Not just this chapter but other chapters like creating wallet address, submitting transactions etc. are being covered at other places and could be linked. Your suggestion has the advantage that the information is not redundant but the disadvantage that it might be inconsistent and overwhelming to newbies. The current documentation has the advantage that it is step by step consistent approach but needs to be maintained in parallel. So the question is, what would be best for someone who is learning to create a pool for the first time?

[rdlrt]

I dont think replacing the page by pointing to existing page rather than repeating information is consistent nor does it increase difficulty for someone new to enter. In fact (sorry if it I come across thick), I dont see a single reason justifiable enough to keep 2 versions of same content on same documentation website, the deviation seen is a natural outcome that neither contributor nor reviewer will always remember to catch as inconsistency 🙂

I am OK with SPO page being kept as fully detailed while Installating Node page is summarised with existing links from SPO guide (which allows step by step for SPO while also allows + link configs/network info being up to date for independent node builders)