mirror of https://gitee.com/pnoker/iot-dc3.git synced 2026-10-31 10:11:49 +08:00

Files

T

History

pnoker 987c96d501 docs(deployment): correct factual errors in DEPLOYMENT.md and USAGE.md

- driver replicas are per-instance nodes with their own RabbitMQ
  command queues (group=dc3.driver.client, key service.node), not
  workers over shared queues; FAQ now also states Compose/Swarm keep
  protocol drivers at 1 replica (shared driver_data / SQLite outbox)
- fail-fast gate covers AUTH_HMAC_SECRET only; DC3_SECURITY_KEY is
  non-empty-checked, so a weak default still boots
- 6271 is intended as the device UDP channel but every publish site
  omits /udp / protocol: UDP and actually publishes TCP - say so
- k8s scaling note: scaled driver pods are independent nodes, not one
  shared worker pool
- swarm runbook: pushing dependency images is a multi-node requirement,
  a local build is fine on a single node
- USAGE.md: NODE_ENV bullet narrowed to weak AUTH_HMAC_SECRET rejected

2026-08-28 23:56:08 +08:00

CHANGE.md

style(repo): reformat java, xml, yaml, markdown and frontend sources

2026-08-25 21:27:49 +08:00

DEPLOYMENT.md

docs(deployment): correct factual errors in DEPLOYMENT.md and USAGE.md

2026-08-28 23:56:08 +08:00

README.md

style: apply repository-wide formatting

2026-08-25 13:35:00 +08:00

RELEASE-FOOTER.md

style: apply repository-wide formatting

2026-08-25 13:35:00 +08:00

TITLE.md

docs(release): update release title tagline to current platform positioning

2026-08-19 17:02:28 +08:00

USAGE.md

docs(deployment): correct factual errors in DEPLOYMENT.md and USAGE.md

2026-08-28 23:56:08 +08:00

README.md

IoT DC3 Documentation

Most documentation has migrated to the project documentation site. This directory keeps only the source files the release process depends on.

Online documentation

Documentation site: https://docs.dc3.site/
Documentation source repository: pnoker/iot-dc3-docs

Files retained in this directory (referenced directly by CI - do not migrate)

File	Purpose
`TITLE.md`	Release title and summary, assembled into the GitHub Release body by `.github/workflows/docker-ci.yml`
`CHANGE.md`	Version changelog, written by `dc3/bin/changelog.py` and assembled into the Release body by docker-ci
`RELEASE-FOOTER.md`	Release quick-start footer (docs links and image pinning), assembled into the Release body by docker-ci
`USAGE.md`	Image usage guide; embedded into the docs site usage page and referenced from the release footer
`DEPLOYMENT.md`	Full deployment runbook (compose scale / swarm / k8s / helm); linked from `USAGE.md` and snapshotted into the docs site by `scripts/sync-external.sh` in the docs repository

The documentation site embeds the changelog and images & deployment pages from the files above through VitePress  syntax, keeping a single source of truth.

Old paths migrated to the documentation site

Old path	New location
`dc3/doc/QUICKSTART.md`	Quick Start
`dc3/doc/ENVIRONMENT.md`	Environment Variables
`dc3/doc/LOGGING.md`	Logging Conventions
`dc3/doc/TROUBLESHOOTING.md`	Troubleshooting
`dc3/doc/MODULES.md`	Modules & Dependencies
`dc3/doc/DRIVER-AUTHORING.md`	Driver Authoring
`dc3/doc/TESTING.md`	Testing

If an external link brought you here, please update your bookmark to the new address.