docs: write the README for people installing netOrk themselves #12

Open
christianmanivong wants to merge 1 commits from docs/customer-readme into main
pull from: docs/customer-readme
Owner

The deploy repository is for customers installing netOrk on their own hosts.

  • README: dropped the Development section, the internal build tags (latest-dev, main-<sha>, feature-<name>), CI wording, issue references and the pointer into netOrk's technical docs. Documents only latest and release numbers; the per-server steps are described in user terms (order as of #11).
  • deploy.env.example: same tag list, override example now 0.37.0 instead of latest-dev.

deploy.sh itself is unchanged and still accepts the internal tags; its comments and error messages still name them.

The deploy repository is for customers installing netOrk on their own hosts. - README: dropped the Development section, the internal build tags (`latest-dev`, `main-<sha>`, `feature-<name>`), CI wording, issue references and the pointer into netOrk's technical docs. Documents only `latest` and release numbers; the per-server steps are described in user terms (order as of #11). - `deploy.env.example`: same tag list, override example now `0.37.0` instead of `latest-dev`. `deploy.sh` itself is unchanged and still accepts the internal tags; its comments and error messages still name them.
christianmanivong added 1 commit 2026-10-18 19:15:33 +00:00
The repository is meant for customers who run netOrk on their own
hosts. Drop the development section, the internal build tags
(latest-dev, main-<sha>, feature-<name>), CI wording and issue
references from the README and deploy.env.example; only latest and
release numbers are documented.
All checks were successful
CI / check (pull_request) Successful in 1m39s
This pull request has changes conflicting with the target branch.
  • README.md
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin docs/customer-readme:docs/customer-readme
git checkout docs/customer-readme
Sign in to join this conversation.