Initialize a "preflight guide" #879
Conversation
amesgen
added
documentation
amesgen
force-pushed
the
amesgen/preflight
branch
from
a245394 to
0c8a5dc
Compare
WDYT about a0f7a05? |
amesgen
force-pushed
the
amesgen/preflight
branch
from
dc26521 to
a0f7a05
Compare
| [Magic Wormhole]: https://github.com/magic-wormhole/magic-wormhole | ||
| [db-analyser]: https://github.com/IntersectMBO/ouroboros-consensus/blob/main/ouroboros-consensus-cardano/README.md#db-analyser | ||
| [Cardano ledger]: https://github.com/IntersectMBO/cardano-ledger | ||
| [Glossary]: https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/Glossary |
There was a problem hiding this comment.
Wouldn't it also be valid to provide a relative path to the file instead of a link to the hosted website? When the website is hosted, it will resolve the relative paths correctly (I think)
There was a problem hiding this comment.
Right, I didn't think of that for some reason. I am too lazy to open a PR for that, let's 🙏 that we don't migrate our website to a different place soon 😄
| Here, "validity" refers most prominently to the ledger rules ("Does this person actually have enough money to make that payment?") of the [Cardano ledger]. | ||
| On disk, the file name of a ledger snapshot usually contains the slot number of its tip point. | ||
|
|
||
| ### Running db-analyser passes |
There was a problem hiding this comment.
I remember that we note somewhere in the docs that you should probably use db-analyser with a copy of an immutable DB, because it might mess with the contents a bit
There was a problem hiding this comment.
Hmm, I locally always use db-analyser directly with the ImmDB of my local node, didn't have problems so far, but that doesn't mean there are no problems. Did you have a specific db-analyser functionality in mind that might be destructive?
Another point: Unless one uses some copy-on-write filesystem (I am still using boring ext4), using a copy of the ImmDB seems quite wasteful, given its current size of >160GB.
Prompted by a suggestion by @RenateEilers, this PR initializes a "preflight guide" that strives to outline various steps (potentially with some dependencies) with the goal to build understanding of the overall Cardano system, with a focus on tasks that are relevant for working in the Consensus team.
I also opened a companion epic at #887 which contains ideas for further steps.
Rendered