From 41b18001666a6a172dbd79250ad8a3bdc95e0c9b Mon Sep 17 00:00:00 2001 From: Akis Kesoglou Date: Wed, 28 Oct 2020 13:09:35 +0200 Subject: [PATCH 1/2] =?UTF-8?q?Reorder=20README=20sections=20to=20bring=20?= =?UTF-8?q?=E2=80=9CGetting=20Started=E2=80=9D=20further=20up?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 92 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 47 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index d85ae4e..1265de8 100644 --- a/README.md +++ b/README.md @@ -25,35 +25,6 @@ To learn more about openBalena, visit [balena.io/open][open-balena-website]. - **Built-in VPN**: Access your devices regardless of their network environment -## Roadmap - -OpenBalena is currently in beta. While fully functional, it lacks features we -consider important before we can comfortably call it production-ready. During -this phase, don’t be alarmed if things don’t work as expected just yet (and -please let us know about any bugs or errors you encounter!). The following -improvements and new functionality is planned: - -- Full documentation -- Full test suite -- Simplified deployment -- Remote host OS updates -- Support for custom device types - - -## Contributing - -Everyone is welcome to contribute to openBalena. There are many different ways -to get involved apart from submitting pull requests, including helping other -users on the [forums][forums], reporting or triaging [issues][issue-tracker], -reviewing and discussing [pull requests][pulls], or just spreading the word. - -All of openBalena is hosted on GitHub. Apart from its constituent components, -which are the [API][open-balena-api], [VPN][open-balena-vpn], [Registry][open-balena-registry], -[S3 storage service][open-balena-s3], and [Database][open-balena-db], contributions -are also welcome to its client-side software such as the [balena CLI][balena-cli], -the [balena SDK][balena-sdk], [balenaOS][balena-os] and [balenaEngine][balena-engine]. - - ## Getting Started Our [Getting Started][getting-started] guide is the most direct path to getting @@ -81,22 +52,6 @@ sections are of particular interest: - [Reference](https://balena.io/docs/reference) - [FAQ](https://balena.io/docs/faq/troubleshooting/faq) -## Differences between openBalena and balenaCloud - -| openBalena | balenaCloud | -| ----- | ---- | -| Device updates using full images | Device updates using [delta images](https://www.balena.io/docs/learn/deploy/delta/) | -| Support for a single user | Support for [multiple users](https://www.balena.io/docs/learn/manage/account/#application-members) | -| Self-hosted deployment and scaling | balena-managed scaling and deployment | -| Community support via [forums](https://forums.balena.io/c/open-balena) | Private support on [paid plans](https://www.balena.io/pricing/) | -| Deploy via `balena deploy` only | Build remotely with native builders using [`balena push`](https://www.balena.io/docs/learn/deploy/deployment/#balena-push) or [`git push`](https://www.balena.io/docs/learn/deploy/deployment/#git-push) | -| No support for building via `git push` | Use the same CI workflow with [`git push`](https://www.balena.io/docs/learn/deploy/deployment/#git-push) | -| No public URL support | Serve websites directly from device with [public device URLs](https://www.balena.io/docs/learn/manage/actions/#enable-public-device-url) | -| Management via `balena-cli` only | Cloud-based device management dashboard | -| Download images from https://www.balena.io/os/ | Download preconfigured images directly from the dashboard | -| No supported remote diagnostics | Remote device diagnostics | - -Additionally, refer back to the [roadmap](#roadmap) above for planned but not yet implemented features. ## Getting Help @@ -107,6 +62,53 @@ for help, or contribute by answering questions posted by fellow openBalena users Please do not use the issue tracker for support-related questions. +## Contributing + +Everyone is welcome to contribute to openBalena. There are many different ways +to get involved apart from submitting pull requests, including helping other +users on the [forums][forums], reporting or triaging [issues][issue-tracker], +reviewing and discussing [pull requests][pulls], or just spreading the word. + +All of openBalena is hosted on GitHub. Apart from its constituent components, +which are the [API][open-balena-api], [VPN][open-balena-vpn], [Registry][open-balena-registry], +[S3 storage service][open-balena-s3], and [Database][open-balena-db], contributions +are also welcome to its client-side software such as the [balena CLI][balena-cli], +the [balena SDK][balena-sdk], [balenaOS][balena-os] and [balenaEngine][balena-engine]. + + +## Roadmap + +OpenBalena is currently in beta. While fully functional, it lacks features we +consider important before we can comfortably call it production-ready. During +this phase, don’t be alarmed if things don’t work as expected just yet (and +please let us know about any bugs or errors you encounter!). The following +improvements and new functionality is planned: + +- Full documentation +- Full test suite +- Simplified deployment +- Remote host OS updates +- Support for custom device types + + +## Differences between openBalena and balenaCloud + +| openBalena | balenaCloud | +| ----- | ---- | +| Device updates using full images | Device updates using [delta images](https://www.balena.io/docs/learn/deploy/delta/) | +| Support for a single user | Support for [multiple users](https://www.balena.io/docs/learn/manage/account/#application-members) | +| Self-hosted deployment and scaling | balena-managed scaling and deployment | +| Community support via [forums][forums] | Private support on [paid plans](https://www.balena.io/pricing/) | +| Deploy via `balena deploy` only | Build remotely with native builders using [`balena push`](https://www.balena.io/docs/learn/deploy/deployment/#balena-push) or [`git push`](https://www.balena.io/docs/learn/deploy/deployment/#git-push) | +| No support for building via `git push` | Use the same CI workflow with [`git push`](https://www.balena.io/docs/learn/deploy/deployment/#git-push) | +| No public URL support | Serve websites directly from device with [public device URLs](https://www.balena.io/docs/learn/manage/actions/#enable-public-device-url) | +| Management via `balena-cli` only | Cloud-based device management dashboard | +| Download images from [balena.io][balena-os-website] | Download preconfigured images directly from the dashboard | +| No supported remote diagnostics | Remote device diagnostics | + +Additionally, refer back to the [roadmap](#roadmap) above for planned but not yet implemented features. + + ## License OpenBalena is licensed under the terms of AGPL v3. See [LICENSE](LICENSE) for details. From 1f7ed769c094030b6c5ee60114498ebdb1e4ccf5 Mon Sep 17 00:00:00 2001 From: Akis Kesoglou Date: Tue, 6 Oct 2020 13:51:28 +0300 Subject: [PATCH 2/2] Update versions of services Change-type: major --- README.md | 14 ++++++++++++-- compose/versions | 12 ++++++------ 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1265de8..faf4b8d 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,21 @@ To learn more about openBalena, visit [balena.io/open][open-balena-website]. ## Getting Started -Our [Getting Started][getting-started] guide is the most direct path to getting +Our [Getting Started guide][getting-started] is the most direct path to getting an openBalena installation up and running and successfully deploying your application to your device(s). -> **IMPORTANT:** Due to changes in [balenaOS][balena-os], only versions up to and including `2.49.0` are currently supported. Additionally, only [balenaCLI](balena-cli) versions `