From e986eb48da54dac07537e7e5f6ab2f63f7edf9d8 Mon Sep 17 00:00:00 2001 From: "Wiktor W." <wykwit@disroot.org> Date: Fri, 3 Nov 2023 07:29:16 +0100 Subject: [PATCH] fix: point formatting in faq - capitalize first letter for each point - finish all the points with a dot - add one point to 'Pros' for Docker-compose - move 'Cons' for Docker-compose into appropriate section --- docs/intro/faq.md | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/docs/intro/faq.md b/docs/intro/faq.md index e3862db93..fbc17a325 100644 --- a/docs/intro/faq.md +++ b/docs/intro/faq.md @@ -14,21 +14,21 @@ The project was started by workers at [Autonomic](https://autonomic.zone/) which #### Pros -- 👍 Thin "ease of use" layer on top of already standardised tooling -- 👍 Extremely modular -- 👍 Collective commons based configuration via public git repos -- 👍 Focussed on hosting providers -- 👍 Uses upstream published containers (no duplication on packaging) -- 👍 Now and always libre software -- 👍 Command line focussed -- 👍 Horizontal and vertical scaling +- 👍 Thin "ease of use" layer on top of already standardised tooling. +- 👍 Extremely modular. +- 👍 Collective commons based configuration via public git repos. +- 👍 Focussed on hosting providers. +- 👍 Uses upstream published containers (no duplication on packaging). +- 👍 Now and always libre software. +- 👍 Command line focussed. +- 👍 Horizontal and vertical scaling. #### Cons -- 👎 Still a very young project -- 👎 Limited availability of well tested apps -- 👎 Requires command line knowledge to use -- 👎 Currently x86 only (see [this FAQ question](#why-only-x86-support) for more) +- 👎 Still a very young project. +- 👎 Limited availability of well tested apps. +- 👎 Requires command line knowledge to use. +- 👎 Currently x86 only (see [this FAQ question](#why-only-x86-support) for more). ## Why start another project? @@ -53,16 +53,16 @@ Here is a short overview of the pros/cons we see, in relation to our goals and n - 👍 Decent web interface for app, domain & user management. - 👍 Large library of apps. - 👍 Built-in SSO using LDAP, which is compatible with more apps and often has a better user interface than OAuth. -- 👍 apps are actively maintained by the Cloudron team. +- 👍 Apps are actively maintained by the Cloudron team. #### Cons - 👎 Moving away from open source. The core is now proprietary software. -- 👎 libre tier has a single app limit. +- 👎 Libre tier has a single app limit. - 👎 Based on Docker images, not stacks, so multi-process apps (e.g. parsoid visual editor for Mediawiki) are a non-starter. - 👎 Difficult to extend apps. - 👎 Only supported on Ubuntu LTS. -- 👎 Upstreams libre software communities aren't involved in packaging. +- 👎 Upstream libre software communities aren't involved in packaging. - 👎 Limited to vertical scaling. - 👎 Tension between needs of hosting provider and non-technical user. - 👎 LDAP introduces security problems - one vulnerable app can expose a user's password for all apps. @@ -113,8 +113,8 @@ Here is a short overview of the pros/cons we see, in relation to our goals and n #### Cons -- 👎 Upstream libre software communities aren't publishing Ansible roles -- 👎 Lots of manual work involved in things like app isolation, backups, updates +- 👎 Upstream libre software communities aren't publishing Ansible roles. +- 👎 Lots of manual work involved in things like app isolation, backups, updates. ### Kubernetes @@ -132,6 +132,10 @@ Here is a short overview of the pros/cons we see, in relation to our goals and n #### Pros +- 👍 Quick to set up and familiar for many developers. + +#### Cons + - 👎 Manual work required for process monitoring. - 👎 Secret storage not available yet. - 👎 [Swarm is the new best practice](https://github.com/BretFisher/ama/issues/8#issuecomment-367575011).