ObolNetwork / ObolNetwork/obol-docs

Improve release checklist

Open
#214 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
MDX
Stars
27
Forks
61
Avg merge
1h 22m
Merged PRs (30d)
2

Description

🎯 Problem to be solved

We should improve the current release checklist (to fix ahead of tagging the release) according to the comments shared in https://docs.google.com/document/d/1Ku4IQ8EbMNcCVSi4awN6qcJOEs1rl-oV11Ygm1a0iis/edit#

🛠️ Proposed solution

  • The security.md page doesn't make a lot of sense and I would probably take some content out of it, not sure where the originally text came from (Section relating to biggest risk being who puts up the funds in particular)
  • It would be great if the run a cluster alone guide made sense with the CDVN repo. Thomas took a first stab at it, and I think it needs the folder structure fix as another iteration, but it still probably makes no sense, and needs fixing if not now then in v0.17.
  • I would rather not instruct people they have to incur downtime to upgrade, it really reduces the usefulness of DVT. We should test that we can rotate one at a time and that we can rotate all at once and that neither risk slashing. Downtime based upgrades should happen next to never, definitely not for something like this such as changing a VC.
  • Need to make better reference to the CDVN slashing risk, which is not currently present. Tag me when it's ready for re-review.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the release checklist, security.md, and the “run a cluster” guide, then compare them with the linked Google document and the CDVN repository structure. Done means the security content, folder references, upgrade guidance, and CDVN slashing-risk reference are revised and ready for re-review.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.