Skip to content

Commit 4692999

Browse files
committed
Fixed headlines in docs
1 parent d4a9dd2 commit 4692999

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+119
-119
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
PHP Censor
2-
----------
2+
==========
33

44
PHP Censor is a fork of PHPCI (And B8Framework) and is a free and open source (BSD-2-Clause license) continuous
55
integration tool specifically designed for PHP. We've built it with simplicity in mind, so whilst it doesn't
66
do *everything* Jenkins can do, it is a breeze to set up and use.
77

88
What it does
9-
============
9+
------------
1010

1111
* Clones your project from Github, Bitbucket or a local path
1212
* Allows you to set up and tear down test databases.
@@ -16,13 +16,13 @@ What it does
1616
* You can mark certain plugins as being allowed to fail (but still run.)
1717

1818
What it doesn't do (yet)
19-
========================
19+
------------------------
2020

2121
* Virtualised testing.
2222
* Multiple PHP-version tests.
2323

2424
Screenshots
25-
===========
25+
-----------
2626

2727
[![Dashboard](docs/screenshots/dashboard.png)](docs/screenshots/dashboard.png)
2828

@@ -35,7 +35,7 @@ Screenshots
3535
[![Build information](docs/screenshots/build-information.png)](docs/screenshots/build-information.png)
3636

3737
Tests
38-
=====
38+
-----
3939

4040
```bash
4141
cd /path/to/php-censor
@@ -47,7 +47,7 @@ For Phar plugin tests set 'phar.readonly' setting to Off (0) in `php.ini` config
4747
For database B8Framework tests create empty 'b8_test' MySQL database on 'localhost' with user/password: `root/root`. Otherwise database tests will be skipped.
4848

4949
Migrations
50-
==========
50+
----------
5151

5252
Run to apply latest migrations:
5353

@@ -64,11 +64,11 @@ cd /path/to/php-censor
6464
```
6565

6666
Documentation
67-
=============
67+
-------------
6868

6969
[PHP Censor documentation](docs/README.md)
7070

7171
License
72-
=======
72+
-------
7373

7474
PHP Censor is open source software licensed under the BSD-2-Clause license.

docs/en/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
PHP Censor documentation
2-
------------------------
2+
========================
33

44
Getting Started
5-
===============
5+
---------------
66

77
* [Installing PHP Censor](installing.md)
88
* [Adding a Virtual Host](virtual_host.md)
@@ -15,7 +15,7 @@ Getting Started
1515
* [Configuring PHP Censor](configuring.md)
1616

1717
Using PHP Censor
18-
================
18+
----------------
1919

2020
* Automatically building commits pushed to
2121
* [Github](sources/github.md)
@@ -26,7 +26,7 @@ Using PHP Censor
2626
* [Project Status Images and Status Page](status.md)
2727

2828
Plugins
29-
=======
29+
-------
3030

3131
* [Atoum](plugins/atoum.md) - `atoum`
3232
* [Behat](plugins/behat.md) - `behat`

docs/en/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Adding PHP Censor Support to Your Projects
2-
------------------------------------------
2+
==========================================
33

44
Similar to Travis CI, to support PHP Censor in your project, you simply need to add a `.php-censor.yml` (`phpci.yml`/`.phpci.yml` for backward compatibility with PHPCI) file to the root of
55
your repository. The file should look something like this:

docs/en/configuring.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Configuring PHP Censor
2-
----------------------
2+
======================
33

44
The PHP Censor configuration on the server is automatically generated into the `config.yml` file during installation. One might need to also edit the file manually.
55

docs/en/installing.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Installing PHP Censor
2-
---------------------
2+
=====================
33

44
What you'll need
5-
================
5+
----------------
66

77
* PHP 5.4.0 or above
88
* A web server (Nginx or Apache)
@@ -13,7 +13,7 @@ What you'll need
1313
* PHP must have OpenSSL support enabled.
1414

1515
Installing PHP Censor from Composer
16-
===================================
16+
-----------------------------------
1717

1818
* Go to the directory in which you want to install PHP Censor, for example: `/var/www`
1919
* Download Composer if you haven't already: `curl -sS https://getcomposer.org/installer | php`
@@ -24,7 +24,7 @@ Installing PHP Censor from Composer
2424
* [Set up the PHP Censor Worker](workers/worker.md), or you can run builds using the [daemon](workers/daemon.md) or [a cron-job](workers/cron.md) to run PHP Censor builds.
2525

2626
Installing PHP Censor Manually
27-
==============================
27+
------------------------------
2828

2929
* Go to the directory in which you want to install PHP Censor, for example: `/var/www`
3030
* [Download PHP Censor](https://github.com/corpsee/php-censor/releases/latest) and unzip it.

docs/en/interpolation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Injecting variables into messages
2-
---------------------------------
2+
=================================
33

44
Most strings used in the build configuration can have variables related to the build inserted into them with the following syntax:
55

docs/en/logging.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Setting up Logging
2-
------------------
2+
==================
33

44
Basics
5-
======
5+
------
66

77
The PHP Censor codebase makes use of the [PSR3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) logging standard. By default we use [Monolog](https://github.com/Seldaek/monolog) to handle the actual work implementing this standard.
88

99
How to Setup Logging (For people running a PHP Censor instance)
10-
===============================================================
10+
---------------------------------------------------------------
1111

1212
The only step required to activate logging is to create a file in the root directory called loggerconfig.php with content like the following:
1313

@@ -27,7 +27,7 @@ This file should return an array of key value pairs. Each key tells PHP Censor w
2727
Once this file is created all plugins and core PHP Censor functionality should start writing to the configured handlers.
2828

2929
How to write to the Log (For people creating a new plugin)
30-
==========================================================
30+
----------------------------------------------------------
3131

3232
### Using the plugin constructor to get a logger directly
3333

docs/en/plugins/atoum.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Atoum
2-
------------
2+
============
33

44
Allows you to run [Atoum](https://github.com/atoum/atoum) unit tests.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/behat.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Behat
2-
------------
2+
============
33

44
A very simple plugin for running [Behat](http://behat.org/) BDD tests.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/campfire.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Campfire
2-
---------------
2+
===============
33

44
This plugin joins a [Campfire](https://campfirenow.com/) room and sends a user-defined message, for example a "Build Succeeded" message.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/clean_build.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Clean build
2-
------------------
2+
==================
33

44
Works through a list of files to remove from your build. Useful when used in combination with Copy Build or Package Build.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/codeception.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Codeception
2-
------------------
2+
==================
33

44
A simple plugin that allows you to run [Codeception](http://codeception.com/) tests.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/composer.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Composer
2-
---------------
2+
===============
33

44
Allows you to run Composer within your build, to install dependencies prior to testing. Best run as a "setup" stage plugin.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

@@ -26,7 +26,7 @@ setup:
2626
```
2727
2828
Warning
29-
=======
29+
-------
3030
3131
If you are using a Composer private repository like Satis, with HTTP authentication, you must check your username and password inside the ```auth.json``` file. PHP Censor uses the ```--no-interaction``` flag, so it will not warn if you must provide that info.
3232

docs/en/plugins/copy_build.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Copy Build
2-
-----------------
2+
=================
33

44
Copies all files from your build, with the exception of those in the "ignore" build settings property, to a directory of your choosing.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/deployer.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Deployer
2-
---------------
2+
===============
33

44
Triggers a deployment of the project to run via [Deployer](http://phpdeployment.org)
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/email.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Email
2-
------------
2+
============
33

44
Sends a build status email.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/env.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Env
2-
----------
2+
==========
33

44
Sets environment variables on the PHP Censor server for the build.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Examples:
1010

docs/en/plugins/grunt.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Grunt
2-
------------
2+
============
33

44
This plugin runs [Grunt](http://gruntjs.com/) tasks.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/hipchat_notify.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Hipchat Notify
2-
---------------------
2+
=====================
33

44
This plugin joins a [HipChat](https://www.hipchat.com/) room and sends a user-defined message, for example a "Build Succeeded" message.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/irc.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin IRC
2-
----------
2+
==========
33

44
Connects to an IRC server and sends a defined message.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/lint.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Lint
2-
-----------
2+
===========
33

44
This plugin runs PHP's built in Lint (syntax / error check) functionality.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/mysql.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin MySQL
2-
------------
2+
============
33

44
Connects to a given MySQL server and runs a selection of queries.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Examples
1010

docs/en/plugins/package_build.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Package Build
2-
--------------------
2+
====================
33

44
Builds a tar or zip archive of your build and places it in a directory of your choosing.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

docs/en/plugins/pdepend.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Plugin Pdepend
2-
--------------
2+
==============
33

44
Runs [PDepend](http://pdepend.org/) software metrics.
55

66
Configuration
7-
=============
7+
-------------
88

99
### Options
1010

0 commit comments

Comments
 (0)