github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #1990 from ligthyear/fix-the-docs

Browse Source 
Highlight features that are yet to come
This commit is contained in:
Jose Diaz-Gonzalez
2016-03-13 15:38:59 -04:00
parent 502d4c9e51 3e1a9abe9b
commit 5507db1d18
9 changed files with 37 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/assets/style.css
View File

@@ -238,6 +238,10 @@ blockquote {
margin-bottom: 30px;
}
blockquote.new-as-of {
border-left: 4px solid #d1f2a5;
background-color: #effab4;
}
blockquote.not-yet-released {
border-left: 4px solid #ef5b58;
background-color: #f9ad76;
}

2
docs/checks-examples.md
View File

@@ -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 <app> Show zero-downtime status

2
docs/deployment/deployment-tasks.md
View File

@@ -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:

2
docs/deployment/dockerfiles.md
View File

@@ -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

1
docs/development/release-process.md
View File

@@ -4,6 +4,7 @@ Dokku is released in intervals *at most* three weeks apart, though may be releas
To propose a release, the following tasks need to be performed:
- Update all blockquote references of `not yet released and only available in master` to point to release version.
- The installable version must be changed in the `contrib/dokku-installer.py` file.
- The installable version must be changed in the `debian/control` file.
- The installable version must be changed in the `docs/home.html` file

2
docs/dokku-storage.md
View File

@@ -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.

2
docs/nginx.md
View File

@@ -10,7 +10,7 @@ nginx:error-logs <app> [-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:

2
docs/proxy.md
View File

@@ -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.

29
docs/template.html
View File

@@ -36,6 +36,9 @@
<link href="https://cdn.rawgit.com/dokku/dokku/v0.4.14/docs/assets/style.css" rel="stylesheet">
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet">
<style>
blockquote.new-as-of {border-left:4px solid #d1f2a5;background-color:#effab4;}
blockquote.not-yet-released {border-left:4px solid #ef5b58;background-color:#f9ad76;}
.rst-versions.rst-badge {display: block;}
.rst-other-versions {text-align: left;}
.rst-other-versions a {border: 0;}
@@ -78,11 +81,18 @@
.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}
.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}
.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}
@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}
.rst-versions.shift{display:block}img{width:100%;height:auto}}
.dev-warning, .outdated-warning {position: absolute;top: 0;width: 100%;padding: 8px 20px 8px;-moz-box-sizing: border-box;-webkit-box-sizing: border-box;box-sizing: border-box;background-image: -webkit-linear-gradient(-45deg, rgba(0,0,0,0.04) 25%, transparent 25%, transparent 50%, rgba(0,0,0,0.04) 50%, rgba(0,0,0,0.04) 75%, transparent 75%, transparent);background-image: -moz-linear-gradient(-45deg, rgba(0,0,0,0.04) 25%, transparent 25%, transparent 50%, rgba(0,0,0,0.04) 50%, rgba(0,0,0,0.04) 75%, transparent 75%, transparent);background-image: linear-gradient(135deg, rgba(0,0,0,0.04) 25%, transparent 25%, transparent 50%, rgba(0,0,0,0.04) 50%, rgba(0,0,0,0.04) 75%, transparent 75%, transparent);font-family: "Roboto", Corbel, Avenir, "Lucida Grande", "Lucida Sans", sans-serif;font-size: 14px;text-align: center;background-color: #ffe761;}
@media screen and (max-width: 768px){
.rst-versions{width:85%;display:none}
.rst-versions.shift{display:block}img{width:100%;height:auto}
.dev-warning, .outdated-warning { position: fixed; min-width: 768px;}
}
</style>
</head>
<body>
<div class="dev-warning doc-floating-warning" style="display:none">
This document is for dokku's development version, which can be significantly different from previous releases. For older releases, use the version selector floating in the bottom right corner of this page.
</div>
<div class="header">
<div class="container-fluid">
<div class="row">
@@ -192,6 +202,10 @@
</div>
</div>
<div class="dev-warning doc-floating-warning" style="display:none">
This document is for dokku's development version, which can be significantly different from previous releases. For older releases, use the version selector floating in the bottom right corner of this page.
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/1.3.0/anchor.js"></script>
<script>
document.addEventListener("DOMContentLoaded", function (e) {
@@ -250,8 +264,10 @@
};
Array.prototype.forEach.call(blockquotes, function (el, i) {
if (el.innerHTML.indexOf('New as of') !== -1) {
if (el.innerHTML.toLowerCase().indexOf('new as of') !== -1) {
addClass(el, 'new-as-of');
} else if (el.innerHTML.toLowerCase().indexOf('not yet released') !== -1) {
addClass(el, 'not-yet-released');
}
});
Array.prototype.forEach.call(classNames, function (className, i) {
@@ -325,6 +341,13 @@
});
};
if (currentVersion == 'master') {
document.querySelectorAll('.dev-warning')[0].style.position = 'relative';
Array.prototype.forEach.call(document.querySelectorAll('.dev-warning'), function (el, i) {
el.style.display = '';
});
}
data = ls2.load('max-versions');
if (!data) {
var request = new XMLHttpRequest();