From 299bf14e7c90d2831ffe701cdc52149548420e3a Mon Sep 17 00:00:00 2001 From: Kasra Bigdeli Date: Sun, 19 Jan 2020 10:26:20 -0500 Subject: [PATCH 1/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7aa3a13..506b5db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,9 @@ Please note we have a code of conduct, please follow it in all your interactions ## IMPORTANT: CapRover Goals & Scope -Since the birth of CapRover, there has been many contributions and suggestions that shaped CapRover as we know it today. One of the very important factor in the contribution you make is to stick with CapRover design philosophy.- CapRover is not an enterprise grade application like Kubernetes. *Do not* patch it with half-done features that make it look like one - it will eventually fail as we don't have resources to support such features.- CapRover scope is a helper around Docker, nginx and Let's Encrypt. If a new feature is doable via the existing features, or a basic tool, do not add it to CapRover. We do not want to bloat this application. One example is: "Add a flag to customize the placement constraints of containers". This is definitely doable in Docker, but we don't want to mirror every single functionality of Docker to CapRover. If we do that, CapRover becomes a very hard to maintain project. Instead we should add customization hooks for these advanced and rare use cases. For example, instead of mirroring every single nginx config, we added the ability of customizing the nginx config for advanced users.- Last but not least AVOID LARGE PULL REQUESTS at all cost as they won't get reviewed unless they are discussed in the Slack channel beforehand. +Since the birth of CapRover, there has been many contributions and suggestions that shaped CapRover as we know it today. One of the very important factor in the contribution you make is to stick with CapRover design philosophy.- CapRover is not an enterprise grade application like Kubernetes. *Do not* patch it with half-done features that make it look like one - it will eventually fail as we don't have resources to support such features.- CapRover scope is a helper around Docker, nginx and Let's Encrypt. + +The goal is to make the common use-cases exposed via simple controls on UI while allowing further customizations to be done through hooks and scripts. If a new feature is doable via the existing features, or a basic tool, do not add it to CapRover. We do not want to bloat this application. One example is: "Add a flag to customize the placement constraints of containers". This is definitely doable in Docker, but we don't want to mirror every single functionality of Docker to CapRover. If we do that, CapRover becomes a very hard to maintain project. Instead we should add customization hooks for these advanced and rare use cases. For example, instead of mirroring every single nginx config, we added the ability of customizing the nginx config for advanced users.- Last but not least AVOID LARGE PULL REQUESTS at all cost as they won't get reviewed unless they are discussed in the Slack channel beforehand. ## Pull Request Process From 404e99df4114c355b7654f139c0d90792018da71 Mon Sep 17 00:00:00 2001 From: Kasra Bigdeli Date: Sun, 19 Jan 2020 11:08:27 -0500 Subject: [PATCH 2/4] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index df3840e..d04cc99 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ ### CapRover (formerly CaptainDuckDuck) +[![](https://images.microbadger.com/badges/image/caprover/caprover.svg)](https://microbadger.com/images/caprover/caprover) [![Docker Pulls](https://img.shields.io/docker/pulls/caprover/caprover.svg)](https://hub.docker.com/r/caprover/caprover/) + #### Easiest app/database deployment platform and webserver package for your NodeJS, Python, PHP, Ruby, Go applications. No Docker, nginx knowledge required!   [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fcaprover%2Fcaprover&via=cap_rover&text=I%20found%20the%20easiest%20webserver%20package%20for%20NodeJS%2C%20PHP%2C%20MySQL%2C%20WordPress%20and%20everything%21&hashtags=CapRover%2Cnodejs%2Cdocker%2Cnginx%2Cwebdev) [![YouTube](https://raw.githubusercontent.com/caprover/caprover-website/master/graphics/screenshots-video-small.gif)](https://www.youtube.com/watch?v=XDrTmGSDW3s) From 8af6781a69d35e488fbfe7e4deaae4647c7899d7 Mon Sep 17 00:00:00 2001 From: Kasra Bigdeli Date: Sun, 19 Jan 2020 11:08:44 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index d04cc99..9b55937 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -### CapRover (formerly CaptainDuckDuck) -[![](https://images.microbadger.com/badges/image/caprover/caprover.svg)](https://microbadger.com/images/caprover/caprover) [![Docker Pulls](https://img.shields.io/docker/pulls/caprover/caprover.svg)](https://hub.docker.com/r/caprover/caprover/) +### CapRover (formerly CaptainDuckDuck) [![Docker Pulls](https://img.shields.io/docker/pulls/caprover/caprover.svg)](https://hub.docker.com/r/caprover/caprover/) #### Easiest app/database deployment platform and webserver package for your NodeJS, Python, PHP, Ruby, Go applications. No Docker, nginx knowledge required!   [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fcaprover%2Fcaprover&via=cap_rover&text=I%20found%20the%20easiest%20webserver%20package%20for%20NodeJS%2C%20PHP%2C%20MySQL%2C%20WordPress%20and%20everything%21&hashtags=CapRover%2Cnodejs%2Cdocker%2Cnginx%2Cwebdev) From 29d771a23669227e65fc7f394a349dedf525cfcf Mon Sep 17 00:00:00 2001 From: Kasra Bigdeli Date: Sun, 19 Jan 2020 12:02:49 -0500 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b55937..e94ccbc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -### CapRover (formerly CaptainDuckDuck) [![Docker Pulls](https://img.shields.io/docker/pulls/caprover/caprover.svg)](https://hub.docker.com/r/caprover/caprover/) +### CapRover [![Docker Pulls](https://img.shields.io/docker/pulls/caprover/caprover.svg)](https://hub.docker.com/r/caprover/caprover/) #### Easiest app/database deployment platform and webserver package for your NodeJS, Python, PHP, Ruby, Go applications. No Docker, nginx knowledge required!   [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fcaprover%2Fcaprover&via=cap_rover&text=I%20found%20the%20easiest%20webserver%20package%20for%20NodeJS%2C%20PHP%2C%20MySQL%2C%20WordPress%20and%20everything%21&hashtags=CapRover%2Cnodejs%2Cdocker%2Cnginx%2Cwebdev)