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

Update tutorial and include Mithril #997

Closed
9 tasks done
ch1bo opened this issue Jul 25, 2023 · 0 comments · Fixed by #1062
Closed
9 tasks done

Update tutorial and include Mithril #997

ch1bo opened this issue Jul 25, 2023 · 0 comments · Fixed by #1062
Labels
amber ⚠️ Medium complexity or partly unclear feature 💬 feature A feature on our roadmap
Milestone

Comments

@ch1bo
Copy link
Member

ch1bo commented Jul 25, 2023

Why

We need to further simplify the getting started experience to ultimately "Make Hydra trivial to use". Similar to the demo setup on a devnet, we want to make a more realistic deployment of a two party Hydra Head on a public testnet possible within minutes (e.g. 15 minutes on preprod).

We already have a tutorial on our website, but this is now outdated and contains a lot of details, which would be better situated in the "further reading" sections of core concepts.

What (TBD)

Within this story, we want to update and extend the tutorial to the latest hydra-node version, include Mithril for a fast bootstrap of cardano-nodes and update the instructions to not use local nodes, but a networked setup.

  • Update tutorial to latest released version
  • Move explanatory parts to core concepts and link there instead
  • Make it shorter
  • Make it about starting nodes on remote machines, u instances and using a public testnet
  • Make each hydra-node use a dedicated cardano-node
  • Use Mithril to fast bootstrap cardano-nodes in the setup

This website gives a clear definition what a tutorial is, how it is different to how-to-guides and other documentation and helps in formulating tutorials: https://documentation.divio.com/tutorials/

How

  • Make sure Hydra works with Mithril, that includes: Upgrade to cardano-node 8 #1007
  • Read https://documentation.divio.com/tutorials/
  • Move conceptual pages out of the way
  • Define "what" the tutorial will do
  • Write tutorial steps Revive tutorial #1035
  • Validate steps with the whole team
  • Review new core-concepts/scalability page
  • Review/merge core-concepts/protocol-outline with core-concepts/index (overview) page
  • Test consistency of tutorials using a CI workflow where possible
    • e.g. checking mithril endpoints vs. mithril docs
@ch1bo ch1bo converted this from a draft issue Jul 25, 2023
@ch1bo ch1bo changed the title Update tutorial to latest version, include Mithril and on a public testnet Update tutorial to latest version and include Mithril Jul 25, 2023
@ch1bo ch1bo added 💬 feature A feature on our roadmap amber ⚠️ Medium complexity or partly unclear feature labels Jul 25, 2023
@ch1bo ch1bo changed the title Update tutorial to latest version and include Mithril Update tutorial and include Mithril Jul 25, 2023
@ch1bo ch1bo moved this to Next in Hydra Head Roadmap Jul 26, 2023
@ch1bo ch1bo self-assigned this Aug 14, 2023
@ch1bo ch1bo mentioned this issue Aug 22, 2023
9 tasks
@ch1bo ch1bo mentioned this issue Sep 6, 2023
5 tasks
@ch1bo ch1bo linked a pull request Sep 6, 2023 that will close this issue
5 tasks
@ch1bo ch1bo removed their assignment Sep 6, 2023
@github-project-automation github-project-automation bot moved this from Next to Done in Hydra Head Roadmap Sep 8, 2023
@ch1bo ch1bo added this to the 0.13.0 milestone Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
amber ⚠️ Medium complexity or partly unclear feature 💬 feature A feature on our roadmap
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant