Skip to content

Update install and use instructions for cardano-node #1453

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

Conversation

jasagredo
Copy link
Contributor

Checklist

Updating documentation or Bugfix

I updated the steps for building the node:

  • Split the system libraries section in tabs by operating system
  • Expand the Windows MSYS2 tab there
  • Provide more info on specific libraries needed
  • Update some env-vars examples
  • Account for cardano-cli not living in cardano-node repository.
  • Properly mention which folder might need to be deleted. If a user deletes db entirely they will have to sync from scratch.

Also for the running example I updated the output with that of a recent cardano-node.

This PR is based on #1451, so reviewing is probably best done by seeing only the changes in the last commit, plus disabling whitespace changes.

If wanted I could merge this one without the other one, but I needed it in order to have a local web server for previews.

@jasagredo jasagredo changed the title Js/update install use instructions node Update install and use instructions for cardano-node Apr 29, 2025
Copy link
Collaborator

@rdlrt rdlrt left a comment

Choose a reason for hiding this comment

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

Nice one..
Left some comments (sorry those may not necessarily be relevant within scope of this PR, but since they're touched - we might as well update things like disk space usage from node 🙂 )
Also, unless intentional - I believe the lock files shouldnt be checked in on documentation updates (perhaps check-in via #1451 makes more sense instead)?

@jasagredo jasagredo force-pushed the js/update-install-use-instructions-node branch 2 times, most recently from aa0384f to cf6aa81 Compare April 30, 2025 06:48
@jasagredo
Copy link
Contributor Author

I re-submitted this PR without the update to docusaurus. Unfortunately I cannot test it locally anymore so I hope it works fine. I adressed the comments above.

@jasagredo jasagredo force-pushed the js/update-install-use-instructions-node branch from cf6aa81 to 0d47db2 Compare April 30, 2025 07:13
@jasagredo jasagredo requested review from rphair and rdlrt April 30, 2025 07:55
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.

@jasagredo this is going to save SPOs and builders a lot of trouble in the days ahead. ⭐ Thanks for factoring out the Docusaurus while we get a consensus how to handle that. I tested the branch locally with

git fetch upstream pull/1453/head:v-1453
git checkout v-1453

and it builds properly, looks and works fine. The style sheet change for the tabs looks good to me & I think is a general improvement in case it cascades into the rest of the site. All changes I recall from @rdlrt's review are also here as far as I can tell. Thanks for all the extra work on this beyond the initial submission. 🙏

Copy link
Collaborator

@CarlosLopezDeLara CarlosLopezDeLara left a comment

Choose a reason for hiding this comment

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

Awesome!

@rphair rphair merged commit 07ec532 into cardano-foundation:staging Apr 30, 2025
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.

4 participants