From b4fcfa1f668cbb3e853b788854a604894bbd824b Mon Sep 17 00:00:00 2001
From: Alex Mayer <amayer5125@gmail.com>
Date: Sat, 3 Apr 2021 11:44:40 -0400
Subject: [PATCH] Standardize Markdown Code Block Syntax (#2479)
---
contrib/npm.php | 8 +++---
docs/KNOWN_BUGS.md | 10 +++-----
docs/cli.md | 56 ++++++++++++++++++++---------------------
docs/contrib/npm.md | 8 +++---
docs/getting-started.md | 4 +--
docs/installation.md | 4 +--
6 files changed, 44 insertions(+), 46 deletions(-)
diff --git a/contrib/npm.php b/contrib/npm.php
index a78fad0a..ed72db1a 100644
--- a/contrib/npm.php
+++ b/contrib/npm.php
@@ -4,9 +4,9 @@
Add to your _deploy.php_
-~~~php
+```php
require 'contrib/npm.php';
-~~~
+```
## Configuration
@@ -14,9 +14,9 @@ require 'contrib/npm.php';
## Usage
-~~~php
+```php
after('deploy:update_code', 'npm:install');
-~~~
+```
*/
namespace Deployer;
diff --git a/docs/KNOWN_BUGS.md b/docs/KNOWN_BUGS.md
index 31083801..3db387d0 100644
--- a/docs/KNOWN_BUGS.md
+++ b/docs/KNOWN_BUGS.md
@@ -2,23 +2,21 @@
## Ubuntu 14.04, Coreutils 8.21
-There are known bug with relative symlinks `ln --relative`, which may fail rollback command.
+There are known bug with relative symlinks `ln --relative`, which may fail rollback command.
Add next line to _deploy.php_ file:
-~~~php
+```php
set('use_relative_symlink', false);
-~~~
-
+```
## OpenSSH_7.2p2
-
+
ControlPersist causes stderr to be left open until the master connection times out.
* https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=714526
* https://bugzilla.mindrot.org/show_bug.cgi?id=1988
-
## cURL 7.29.0
Certificate verification fails with multiple https urls.
diff --git a/docs/cli.md b/docs/cli.md
index 90705229..0b1c3e6d 100755
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -2,10 +2,10 @@
After [installation](installation.md) of Deployer you will have the ability to run the `dep` command from your terminal.
-To get list of all available tasks run the `dep` command. You can run it from any subdirectories of you project;
-Deployer will automatically find project root dir.
-
-~~~bash
+To get list of all available tasks run the `dep` command. You can run it from any subdirectories of you project;
+Deployer will automatically find project root dir.
+
+```bash
Deployer
Usage:
@@ -28,19 +28,19 @@ Available commands:
run Run any arbitrary command on hosts
self-update Updates deployer.phar to the latest version
ssh Connect to host through ssh
-~~~
+```
The best way to configure your `deploy.php` is to automatically deploy to staging on this command:
-
-~~~bash
+
+```bash
dep deploy
-~~~
+```
This is so somebody can't accidentally deploy to production (for production deployment, the `dep deploy production` command explicitly lists the required production stage).
You need info about available options and usage use the `help` command:
-
-~~~bash
+
+```bash
$ dep help deploy
Usage:
deploy [options] [--] [<stage>]
@@ -67,62 +67,62 @@ Options:
--revision[=REVISION] Revision to deploy
--branch[=BRANCH] Branch to deploy
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
+
Help:
Deploy your project
-~~~
+```
### Overriding configuration options
For example, if your _deploy.php_ file contains this configuration:
-~~~php
+```php
set('ssh_multiplexing', false);
-~~~
+```
And you want to enable [ssh multiplexing](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Multiplexing) without modifying the file, you can pass the `-o` option to the `dep` command:
-~~~bash
+```bash
dep deploy -o ssh_multiplexing=true
-~~~
+```
To override multiple config options, you can pass multiple `-o` args:
-~~~bash
+```bash
dep deploy -o ssh_multiplexing=true -o branch=master
-~~~
+```
### Running arbitrary commands
-
+
Deployer comes with a command to run any valid command on you server without modifying _deploy.php_
-
-~~~bash
+
+```bash
dep run 'ls -la'
-~~~
+```
To specify the hosts this command has the corresponding options:
-~~~
+```
--stage=STAGE Stage to deploy
--roles=ROLES Roles to deploy
--hosts=HOSTS Host to deploy, comma separated, supports ranges [:]
-~~~
+```
### Getting help
You can get more info about any commands by using the help command:
-~~~
+```bash
dep help [command]
-~~~
+```
### Autocomplete
Deployer comes with an autocomplete script for bash/zsh/fish, so you don't need to remember all the tasks and options.
To install it run following command:
-~~~bash
+```bash
dep autocomplete
-~~~
+```
And follow instructions.
diff --git a/docs/contrib/npm.md b/docs/contrib/npm.md
index e6852210..d76fccea 100644
--- a/docs/contrib/npm.md
+++ b/docs/contrib/npm.md
@@ -11,9 +11,9 @@
Add to your _deploy.php_
-~~~php
+```php
require 'contrib/npm.php';
-~~~
+```
## Configuration
@@ -21,9 +21,9 @@ require 'contrib/npm.php';
## Usage
-~~~php
+```php
after('deploy:update_code', 'npm:install');
-~~~
+```
diff --git a/docs/getting-started.md b/docs/getting-started.md
index a4212959..f55e7fa3 100755
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -142,9 +142,9 @@ after('deploy', 'reload:php-fpm');
If you need to connect to the host, Deployer has a shortcut for faster access:
-~~~sh
+```sh
dep ssh
-~~~
+```
This command will connect to selected hosts and cd to `current_path`.
diff --git a/docs/installation.md b/docs/installation.md
index 7cab4aa9..5d54e6eb 100755
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -91,9 +91,9 @@ This will build the `deployer.phar` phar archive.
Deployer comes with an autocomplete script for bash/zsh/fish, so you don't need to remember all tasks and options.
To install, run the following command:
-~~~bash
+```sh
dep autocomplete
-~~~
+```
And follow the instructions.