From 9af8389616153b405ba849446c63ceaff2b93059 Mon Sep 17 00:00:00 2001 From: Benjamin Kampmann Date: Sun, 13 Mar 2016 11:12:26 +0100 Subject: [PATCH 1/8] Highlight features that are yet to come - Tone down "new as of version" boxes - Replace all "New as of 0.5" with "yet to be released" text - Use strong red only for "yet to be released" boxes Fixes #1989 --- docs/assets/style.css | 4 ++++ docs/checks-examples.md | 2 +- docs/deployment/deployment-tasks.md | 2 +- docs/deployment/dockerfiles.md | 2 +- docs/dokku-storage.md | 2 +- docs/nginx.md | 2 +- docs/proxy.md | 2 +- docs/template.html | 2 ++ 8 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/assets/style.css b/docs/assets/style.css index 001b5c387..418294544 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -238,6 +238,10 @@ blockquote { margin-bottom: 30px; } blockquote.new-as-of { + border-left: 4px solid #f0ad4e; + background-color: #f0dc6e; +} +blockquote.not-yet-released { border-left: 4px solid #ef5b58; background-color: #f9ad76; } diff --git a/docs/checks-examples.md b/docs/checks-examples.md index 9177243a4..196b9fab6 100644 --- a/docs/checks-examples.md +++ b/docs/checks-examples.md @@ -1,6 +1,6 @@ # Zero Downtime Deploys -> Plugin management is New as of 0.5.0 +> Plugin management is not yet released and only available in master ``` checks Show zero-downtime status diff --git a/docs/deployment/deployment-tasks.md b/docs/deployment/deployment-tasks.md index c5685100b..f6c5addd6 100644 --- a/docs/deployment/deployment-tasks.md +++ b/docs/deployment/deployment-tasks.md @@ -1,6 +1,6 @@ # Deployment Tasks -> New as of 0.5.0 +> not yet released and only available in master Sometimes you need to run a command on at deployment time, but before an app is completely deployed. Common use cases include: diff --git a/docs/deployment/dockerfiles.md b/docs/deployment/dockerfiles.md index ab990c1bc..2fa1331f9 100644 --- a/docs/deployment/dockerfiles.md +++ b/docs/deployment/dockerfiles.md @@ -42,7 +42,7 @@ Setting `$DOKKU_DOCKERFILE_CACHE_BUILD` to `true` or `false` will enable or disa ### Procfiles and Multiple Processes -> New as of 0.5.0 +> not yet released and only available in master You can also customize the run command using a `Procfile`, much like you would on Heroku or with a buildpack deployed app. The `Procfile` should contain one or more lines defining [process diff --git a/docs/dokku-storage.md b/docs/dokku-storage.md index ee7412efc..498cd1df2 100644 --- a/docs/dokku-storage.md +++ b/docs/dokku-storage.md @@ -1,6 +1,6 @@ # Dokku Core Storage Plugin -> New as of 0.5.0 +> not yet released and only available in master The preferred method to mount external containers to a dokku managed container, is to use the dokku storage plugin. diff --git a/docs/nginx.md b/docs/nginx.md index 7aaad3b7e..8f7296d06 100644 --- a/docs/nginx.md +++ b/docs/nginx.md @@ -10,7 +10,7 @@ nginx:error-logs [-t] ## Customizing the nginx configuration -> New as of 0.5.0 +> not yet released and only available in master Dokku uses a templating library by the name of [sigil](https://github.com/gliderlabs/sigil) to generate nginx configuration for each app. If you'd like to provide a custom template for your application, there are a couple options: diff --git a/docs/proxy.md b/docs/proxy.md index ae3763734..549a34525 100644 --- a/docs/proxy.md +++ b/docs/proxy.md @@ -1,6 +1,6 @@ # Proxy plugin -> New as of 0.5.0 +> not yet released and only available in master As of dokku 0.5.0, the proxy functionality has been decoupled from the nginx-vhosts plugin into the proxy plugin. In the future this will allow other proxy software (HAproxy for example) to be used instead of nginx. diff --git a/docs/template.html b/docs/template.html index 173f30497..62fbec887 100644 --- a/docs/template.html +++ b/docs/template.html @@ -252,6 +252,8 @@ Array.prototype.forEach.call(blockquotes, function (el, i) { if (el.innerHTML.indexOf('New as of') !== -1) { addClass(el, 'new-as-of'); + } else if (el.innerHTML.indexOf('not yet released') !== -1) { + addClass(el, 'not-yet-released'); } }); Array.prototype.forEach.call(classNames, function (className, i) { From 770c088507bdfe89c5ca92ee145d667ea4e25789 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sun, 13 Mar 2016 06:38:27 -0400 Subject: [PATCH 2/8] Fix colors to be green green == good to go, or released in a stable version. --- docs/assets/style.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/assets/style.css b/docs/assets/style.css index 418294544..b5844ff8d 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -238,8 +238,8 @@ blockquote { margin-bottom: 30px; } blockquote.new-as-of { - border-left: 4px solid #f0ad4e; - background-color: #f0dc6e; + border-left: 4px solid #7ad375; + background-color: #a6e22d; } blockquote.not-yet-released { border-left: 4px solid #ef5b58; From 6ed64724c0b3af5c110d01d7a35216a70d4046c5 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sun, 13 Mar 2016 06:42:14 -0400 Subject: [PATCH 3/8] Added yellow banner stating for doc release status Also add the appropriate blockquote overrides in the template.html --- docs/template.html | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/template.html b/docs/template.html index 62fbec887..e2d8c4344 100644 --- a/docs/template.html +++ b/docs/template.html @@ -36,6 +36,9 @@ +
@@ -192,6 +202,10 @@
+ +