[2.8] Docs: ingestion docs, identity ADR, operator upgrade runbook

Closed
  • Is something wrong?
#465 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

A pull request for this has already been merged.

  • #466 by @pskillen — merged

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
docker, markdown, python
Domain
documentation

Research direction

Start with the three existing docs under docs/features/packet-ingestion/ (meshtastic.md, PACKET_FIELDS.md, DEDUPLICATION.md) and the parent tracker pskillen/meshflow-api#437 for the 2.8.x context. The ADR on Meshtastic identity linking and the operator runbook (signing policy, telemetry settings, bot version requirements) need maintainer-level decisions before they can be written. Done means the field docs match 2.8 behaviour and the runbook and ADR are merged.

Written by the indexing model from the issue text.

Description

enhancement meshtastic-2.8

Part of pskillen/meshflow-api#437 (Meshtastic 2.8.x support). Code: DC-1 · Priority: Should (runbook Must) · Size: M

Summary

  • Update docs/features/packet-ingestion/meshtastic.md, PACKET_FIELDS.md, DEDUPLICATION.md for 2.8.
  • ADR for Meshtastic identity linking in docs/features/packet-ingestion/adr/.
  • Operator upgrade runbook (must exist before any feeder upgrade): Compatible signing policy on feeders (Strict would drop 2.7 senders); consider TM position_min_interval_secs=0; telemetry settings; never full-erase a feeder (rotates the key and breaks prediction); bot version requirements.

Acceptance criteria

  • Runbook published before first prod feeder upgrade
  • ADR merged
  • Field docs updated

Depends on: none

Dominant language
Python
Stars
1
Forks
0
Avg merge
23h 9m
Merged PRs (30d)
15

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

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.

More from pskillen/meshflow-api

All issues in pskillen/meshflow-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.