Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cardano Relay Configuration: fix & clarify instructions #1162

Merged
merged 7 commits into from
Nov 2, 2023

Conversation

sanskys
Copy link
Contributor

@sanskys sanskys commented Oct 9, 2023

  • I have read the How to Contribute.
  • I have run yarn build after adding my changes without getting any errors.

Updating documentation or Bugfix

Documentation Update to Fix #1140

  1. $HOME is being replaced by <$HOME> to reflect real value
  2. ".local" is being replaced by "local"
  3. conway-genesis.json file has been added

Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this page is maintainable for reasons @rdlrt already gave in #1140 (comment) ... and therefore I believe most of the content on this page should be replaced with links to the relevant sections on the canonical page Installing cardano-node and cardano-cli from source.

As long as the redundancy in the page remains, though, we would still have to do some cleanup. Some feedback about the proposed changes:

@rphair rphair changed the title Documentation Update to Fix #1140 Cardano Relay Configuration: fix & clarify instructions Oct 10, 2023
@sanskys
Copy link
Contributor Author

sanskys commented Oct 31, 2023

if a cleanup is planned, should i close this PR. Alternatively, i could make the suggested changes as an interim solution?

@rphair
Copy link
Collaborator

rphair commented Oct 31, 2023

@sanskys I would want to hear what other reviewers think about this, but I still firmly believe the only suitable change to make to this page is to eliminate the redundant material, replacing it with link(s) to the more canonical Dev Portal source.

Perhaps the page & workflow could be simplified with wording like: "Now that you've created a node according to these (link) standard instructions, here's how to configure it as a relay for your stake pool."

In any case I believe it would be a huge contribution if you could revise your fixes to strip down most of the content & only include those instructions that are unique to SPOs & their relays, without the general node maintenance & operation. What do you think of that plan? 🤓

@sanskys
Copy link
Contributor Author

sanskys commented Nov 1, 2023

@sanskys I would want to hear what other reviewers think about this, but I still firmly believe the only suitable change to make to this page is to eliminate the redundant material, replacing it with link(s) to the more canonical Dev Portal source.

Perhaps the page & workflow could be simplified with wording like: "Now that you've created a node according to these (link) standard instructions, here's how to configure it as a relay for your stake pool."

In any case I believe it would be a huge contribution if you could revise your fixes to strip down most of the content & only include those instructions that are unique to SPOs & their relays, without the general node maintenance & operation. What do you think of that plan? 🤓

@rphair thats fine for me. But since the cleanup would take some time, I would recommend to merge these changes and open a new Issue. I would also like to hear more voices before starting. It should not be that after the cleanup everyone finds it a mishmash :)

@rphair
Copy link
Collaborator

rphair commented Nov 2, 2023

sure thing @sanskys - I'll approve this for merge if it gets approval from 2 other reviewers. 🙂

@rphair
Copy link
Collaborator

rphair commented Nov 2, 2023

I've backed out all the superflous & contraindicated changes from the standard ~/.local to the unusual ~/local. The only remaining changes here are the vital Conway genesis file & the less vital instructions about updating the "script" which also adds the error-prone angle brackets. Due to the latter issue I believe this should be considered an interim edit, pending I hope folding most of this page into links to more canonical instructions 🤓

@rphair rphair merged commit 3f190f7 into cardano-foundation:staging Nov 2, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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