Skip to content
This repository was archived by the owner on Jan 30, 2024. It is now read-only.

Commit 8462542

Browse files
committed
use correct headers
1 parent 39fb432 commit 8462542

11 files changed

Lines changed: 31 additions & 40 deletions

File tree

guides/php-app/deployment.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ set :remote_web_root_path, 'web'
133133
cap dev php:clear_opcache
134134
{% endhighlight %}
135135

136-
#### Output
136+
### Output
137137

138138
{% highlight shell-session%}
139139
00:00 php:clear_opcache
@@ -154,7 +154,3 @@ In our **deploy.rb** we add the following lines:
154154
after 'deploy:finished', 'php:clear_opcache'
155155
{% endhighlight %}
156156

157-
158-
## Customizing group and file permissions
159-
160-
##

rake/dkdeploy-core/assets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ section: "rake"
55
layout: default
66
---
77

8-
#### Configuration
8+
### Configuration
99

1010
Add these variables in your deploy.rb file before using any of the tasks below.
1111

@@ -78,7 +78,7 @@ Empty asset folders.
7878

7979
Compiles sass files in a css file.
8080

81-
#### Configuration
81+
### Configuration
8282

8383
Set your sass file paths or whole directory paths from your project in **:compass_sources**.
8484
Possible values for `:compass_compile_arguments` are `['--boring', '--environment', 'production']`.

rake/dkdeploy-core/bower.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ See [bower.io](http://bower.io/) for details about bower.
6868

6969
### Configuration
7070

71-
#### Variables
72-
7371
By default dkdeploy will assume the `:bower_paths` path as directories of your bower.json files. You can overwrite this by setting the variable `:bower_paths` in your Capistrano configuration. By default, the `:bower_paths` variable fetches from the `:copy_source` variable.
7472

7573
Again, the multiple directories are relative the current working directory.

rake/dkdeploy-core/current_folder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ htdocs contains three subdirectories (**current**, **releases** and **shared**)
1111
If no deployment was done before, **current** is a directory. If there already was a deployment earlier, it is a symlink.
1212
This task deletes the **current** directory, unless it is a symlink.
1313

14-
#### Usage
14+
### Usage
1515

1616
in **config/deploy.rb**:
1717
{% highlight ruby %}
1818
before 'deploy:publishing', 'current_folder:remove_unlesss_symlinked'
1919
{% endhighlight %}
2020

21-
#### Output
21+
### Output
2222

2323
There is no output generated if the current directory is removed, if nothing is done, an event **info.ignoring_current_folder** is logged.

rake/dkdeploy-core/db.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ db_settings.{{site.data.constants.deploy.stage}}.yaml
192192

193193
There are no variables that need to be configured.
194194

195-
#### Usage
195+
### Usage
196196

197197
This task is used internally when
198198

@@ -207,7 +207,7 @@ $ cap {{site.data.constants.deploy.stage}} db:read_db_settings
207207
This task raises an error if the configuration file does not exists on the target stage.
208208
</div>
209209

210-
#### Output
210+
### Output
211211

212212
There is no output on the screen.
213213
The Yaml file is available in the temp directory.

rake/dkdeploy-core/enhanced_symlinks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ layout: default
1010

1111
**deploy.rb** contains a hash of `:enhanced_linked_dirs`. The linked_dirs task reads this hash and creates the directories listed in the key of this hash, if they do not exist.
1212

13-
#### Configuration
13+
### Configuration
1414

1515
Listing of `:enhanced_linked_dirs` in **deploy.rb:**
1616
{% highlight ruby %}

rake/dkdeploy-core/fail.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ layout: default
99

1010
Raises internal failure condition.
1111

12-
#### Usage
12+
### Usage
1313

1414
Use this function within your own ruby tasks to raise errors during the execution.
1515

@@ -21,7 +21,7 @@ end
2121
{% endhighlight %}
2222

2323

24-
#### Output
24+
### Output
2525

2626
The output will be the provided errors.<br/>
2727
The deployment will be aborted.

rake/dkdeploy-core/file_access.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,34 @@ layout: default
99

1010
Sets owner and group of the shared and release path. This task invokes **set_owner_group_of_shared_path** and **set_owner_group_of_release_path**.
1111

12-
#### Usage
12+
### Usage
1313

1414
{% highlight shell %}
1515
$ cap {{site.data.constants.deploy.stage}} file_access:set_owner_group
1616
{% endhighlight %}
1717

18-
#### Output
18+
### Output
1919

2020
See outputs in tasks **set_owner_group_of_shared_path** and **set_owner_group_of_release_path**.
2121

2222
## set_owner_group_of_shared_path
2323

2424
Sets owner and group of the shared path.
2525

26-
#### Configuration
26+
### Configuration
2727

2828
{% highlight ruby %}
2929
set :default_file_access_owner_of_shared_path, "{{site.data.constants.deploy.user}}"
3030
set :default_file_access_group_of_shared_path, "{{site.data.constants.deploy.group}}"
3131
{% endhighlight %}
3232

33-
#### Usage
33+
### Usage
3434

3535
{% highlight shell %}
3636
$ cap {{site.data.constants.deploy.stage}} file_access:set_owner_group_of_shared_path
3737
{% endhighlight %}
3838

39-
#### Output
39+
### Output
4040

4141
{% highlight shell %}
4242
$ sudo chown {{site.data.constants.deploy.user}}:{{site.data.constants.deploy.group}} [project_path]/shared

rake/dkdeploy-core/maintenance.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,67 +9,66 @@ layout: default
99

1010
Creates a maintenance.json file.
1111

12-
#### Configuration
12+
### Configuration
1313

1414
none
1515

16-
#### Usage
16+
### Usage
1717

1818
{% highlight shell %}
1919
$ cap {{site.data.constants.deploy.stage}} maintenance:enable
2020
{% endhighlight %}
2121

2222

23-
#### Output
23+
### Output
2424

2525
Creates the file **shared_path/config/maintenance.json** with no content
2626

2727
## enable_permanent
2828

2929
Creates a maintenance.json file.
3030

31-
#### Configuration
31+
### Configuration
3232

3333
none
3434

35-
#### Usage
35+
### Usage
3636

3737
{% highlight shell %}
3838
$ cap {{site.data.constants.deploy.stage}} maintenance:enable_permanent
3939
{% endhighlight %}
4040

4141

42-
#### Output
42+
### Output
4343

4444
Creates the file **shared_path/config/maintenance.json** with enabled_permanent: true
4545

4646
## disable
4747

4848
Removes a maintenance.json file. Ony works if the maintenance mode wasnt set with enable_permanent, if so use disable_permanent.
4949

50-
#### Configuration
50+
### Configuration
5151

5252
none
5353

54-
#### Usage
54+
### Usage
5555

5656
{% highlight shell %}
5757
$ cap {{site.data.constants.deploy.stage}} maintenance:disable
5858
{% endhighlight %}
5959

60-
6160
## disable_permanent
6261

6362
Removes a maintenance.json file.
6463

65-
#### Usage
64+
### Usage
6665

6766
{% highlight shell %}
6867
$ cap {{site.data.constants.deploy.stage}} maintenance:disable_permanent
6968
{% endhighlight %}
7069

7170

72-
#### Output
71+
### Output
7372

7473
none
7574

rake/dkdeploy-core/new_release_path.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ $ BUILD_TAG=1 JOB_NAME=foo BUILD_NUMBER=bar cap {{site.data.constants.deploy.sta
3939

4040
= **{{site.data.constants.deploy.release2_folder}}**
4141

42-
43-
4442
## failed
4543

4644
Handle deployment errors
@@ -59,17 +57,17 @@ Remove and archive rolled-back release.
5957

6058
This task simulates a failing deployments. It is used for the tests - especially for testing the Rollback Manager.
6159

62-
#### Configuration
60+
### Configuration
6361

6462
There is nothing to configure, the task simply raises an exception.
6563

66-
#### Usage
64+
### Usage
6765

6866
Example usage:
6967
{% highlight shell %}
7068
$ cap {{site.data.constants.deploy.stage}} deploy:fail
7169
{% endhighlight %}
7270

73-
#### Output
71+
### Output
7472

7573
A console output that the deployment has failed.

0 commit comments

Comments
 (0)