lf-edge / lf-edge/eve-api

Document cluster concepts: designated node ID, formation, recovery, and updates

Open
#66 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dockerfile
Stars
2
Forks
18
Avg merge
2d 11h
Merged PRs (30d)
3

Description

As we go forward we should document a bit more how this designated node id and other cluster concepts work - maybe start on a docs/EDGE-NODE-CLUSTERS.md and cover the cluster formation, recovery/replacement, and updates. Does Andrew already have some things written up to start such a document?

Originally posted by @eriknordmark in https://github.com/lf-edge/eve-api/pull/65#pullrequestreview-2264410291

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 checking whether Andrew has existing material that can inform docs/EDGE-NODE-CLUSTERS.md. Use the issue's requested topics—designated node ID, cluster formation, recovery or replacement, and updates—to define the document scope. Done means the new document explains each of those cluster concepts clearly.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.