Documentation improvements.
This commit is contained in:
parent
4ae7619340
commit
20771e002e
|
@ -31,7 +31,7 @@ Pull request [#142](https://github.com/php-censor/php-censor/pull/142).
|
||||||
|
|
||||||
- Application Cache class and replaced by Symfony/Cache component.
|
- Application Cache class and replaced by Symfony/Cache component.
|
||||||
- Useless Template class and refactored View.
|
- Useless Template class and refactored View.
|
||||||
- User model from $_SESSION.
|
- User model from `$_SESSION`.
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
|
|
14
README.md
14
README.md
|
@ -42,11 +42,14 @@ More [screenshots](docs/en/screenshots.md).
|
||||||
|
|
||||||
* Database (MySQL/MariaDB or PostgreSQL);
|
* Database (MySQL/MariaDB or PostgreSQL);
|
||||||
|
|
||||||
* Beanstalkd queue (Optional);
|
* Beanstalkd queue (Optional, needed if you use [worker](docs/en/workers/worker.md) instead of
|
||||||
|
[cronjob](docs/en/workers/cron.md));
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Clone project from GitHub, Bitbucket, GitLab, Git, Mercurial, SVN or from local directory;
|
* Clone project from [GitHub](docs/en/sources/github.md), [Bitbucket](docs/en/sources/bitbucket.md) (Git/Hg),
|
||||||
|
[GitLab](docs/en/sources/gitlab.md), [Git](docs/en/sources/git.md), Hg (Mercurial), SVN (Subversion) or from local
|
||||||
|
directory;
|
||||||
|
|
||||||
* Set up and tear down database tests for [PostgreSQL](docs/en/plugins/pgsql.md), [MySQL](docs/en/plugins/mysql.md) or
|
* Set up and tear down database tests for [PostgreSQL](docs/en/plugins/pgsql.md), [MySQL](docs/en/plugins/mysql.md) or
|
||||||
[SQLite](docs/en/plugins/sqlite.md);
|
[SQLite](docs/en/plugins/sqlite.md);
|
||||||
|
@ -58,10 +61,11 @@ More [screenshots](docs/en/screenshots.md).
|
||||||
* Check code via Lint, PHPParallelLint, Pdepend, PHPCodeSniffer, PHPCpd, PHPCsFixer, PHPDocblockChecker, PHPLoc,
|
* Check code via Lint, PHPParallelLint, Pdepend, PHPCodeSniffer, PHPCpd, PHPCsFixer, PHPDocblockChecker, PHPLoc,
|
||||||
PHPMessDetect, PHPTalLint and TechnicalDept;
|
PHPMessDetect, PHPTalLint and TechnicalDept;
|
||||||
|
|
||||||
* Run through any combination of the other [supported plugins](docs/en/README.md#plugins), including Campfire, CleanBuild,
|
* Run through any combination of the other [supported plugins](docs/en/README.md#plugins), including Campfire,
|
||||||
CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe;
|
CleanBuild, CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe;
|
||||||
|
|
||||||
* Send notifications on Email, XMPP, Slack, IRC, Flowdock, HipChat and [Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin);
|
* Send notifications on Email, XMPP, Slack, IRC, Flowdock, HipChat and
|
||||||
|
[Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin);
|
||||||
|
|
||||||
* Use your LDAP-server for authentication;
|
* Use your LDAP-server for authentication;
|
||||||
|
|
||||||
|
|
|
@ -16,10 +16,14 @@ Using PHP Censor
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
* Automatically building commits pushed to
|
* Automatically building commits pushed to
|
||||||
* [Github](sources/github.md)
|
|
||||||
* [Bitbucket](sources/bitbucket.md)
|
|
||||||
* [GitLab](sources/gitlab.md)
|
|
||||||
* [Git](sources/git.md)
|
* [Git](sources/git.md)
|
||||||
|
* [Github (Git)](sources/github.md)
|
||||||
|
* [Bitbucket (Git)](sources/bitbucket.md)
|
||||||
|
* [GitLab (Git)](sources/gitlab.md)
|
||||||
|
* Gogs (Git)
|
||||||
|
* Mercurial/Hg
|
||||||
|
* Bitbucket (Hg)
|
||||||
|
* Subversion/Svn
|
||||||
* [Injecting variables into messages](interpolation.md)
|
* [Injecting variables into messages](interpolation.md)
|
||||||
* [Project Status Images and Status Page](status.md)
|
* [Project Status Images and Status Page](status.md)
|
||||||
* [Build environments](environments.md)
|
* [Build environments](environments.md)
|
||||||
|
@ -29,29 +33,23 @@ Plugins
|
||||||
|
|
||||||
### Internal plugins
|
### Internal plugins
|
||||||
|
|
||||||
|
#### Dependencies
|
||||||
|
|
||||||
|
* [Composer](plugins/composer.md) - `composer`
|
||||||
|
* [Security Checker](plugins/security_checker.md) - SensioLabs Security Checker Plugin (`security_checker`).
|
||||||
|
|
||||||
|
#### Tests
|
||||||
|
|
||||||
* [Atoum](plugins/atoum.md) - `atoum`
|
* [Atoum](plugins/atoum.md) - `atoum`
|
||||||
* [Behat](plugins/behat.md) - `behat`
|
* [Behat](plugins/behat.md) - `behat`
|
||||||
* [Campfire](plugins/campfire.md) - `campfire`
|
|
||||||
* [Clean Build](plugins/clean_build.md) - `clean_build`
|
|
||||||
* [Codeception](plugins/codeception.md) - `codeception`
|
* [Codeception](plugins/codeception.md) - `codeception`
|
||||||
* [Composer](plugins/composer.md) - `composer`
|
* [PHP Unit](plugins/php_unit.md) - `php_unit`
|
||||||
* [Copy Build](plugins/copy_build.md) - `copy_build`
|
* [PHP Spec](plugins/php_spec.md) - `php_spec`
|
||||||
* [Deployer](plugins/deployer.md) - `deployer`
|
|
||||||
* [Email](plugins/email.md) - `email`
|
#### Code style
|
||||||
* [Env](plugins/env.md) - `env`
|
|
||||||
* [Grunt](plugins/grunt.md) - `grunt`
|
|
||||||
* [Hipchat](plugins/hipchat_notify.md) - `hipchat_notify`
|
|
||||||
* [IRC](plugins/irc.md) - `irc`
|
|
||||||
* [Lint](plugins/lint.md) - `lint`
|
* [Lint](plugins/lint.md) - `lint`
|
||||||
* [Mage](plugins/mage.md) - `mage`
|
|
||||||
* [Mage v3](plugins/mage3.md) - `mage3`
|
|
||||||
* [MySQL](plugins/mysql.md) - `mysql`
|
|
||||||
* [Package Build](plugins/package_build.md) - `package_build`
|
|
||||||
* [PDepend](plugins/pdepend.md) - `pdepend`
|
* [PDepend](plugins/pdepend.md) - `pdepend`
|
||||||
* [PostgreSQL](plugins/pgsql.md) - `pgsql`
|
|
||||||
* [SQLite](plugins/sqlite.md) - `sqlite`
|
|
||||||
* [Phar](plugins/phar.md) - `phar`
|
|
||||||
* [Phing](plugins/phing.md) - `phing`
|
|
||||||
* [PHP Code Sniffer](plugins/php_code_sniffer.md) - `php_code_sniffer`
|
* [PHP Code Sniffer](plugins/php_code_sniffer.md) - `php_code_sniffer`
|
||||||
* [PHP Copy/Paste Detector](plugins/php_cpd.md) - `php_cpd`
|
* [PHP Copy/Paste Detector](plugins/php_cpd.md) - `php_cpd`
|
||||||
* [PHP Coding Standards Fixer](plugins/php_cs_fixes.md) - `php_cs_fixer`
|
* [PHP Coding Standards Fixer](plugins/php_cs_fixes.md) - `php_cs_fixer`
|
||||||
|
@ -59,17 +57,48 @@ Plugins
|
||||||
* [PHP Loc](plugins/php_loc.md) - `php_loc`
|
* [PHP Loc](plugins/php_loc.md) - `php_loc`
|
||||||
* [PHP Mess Detector](plugins/php_mess_detector.md) - `php_mess_detector`
|
* [PHP Mess Detector](plugins/php_mess_detector.md) - `php_mess_detector`
|
||||||
* [PHP Parallel Lint](plugins/php_parallel_lint.md) - `php_parallel_lint`
|
* [PHP Parallel Lint](plugins/php_parallel_lint.md) - `php_parallel_lint`
|
||||||
* [PHP Spec](plugins/php_spec.md) - `php_spec`
|
* PHP Tal Lint - `php_tal_lint`
|
||||||
* [PHP Unit](plugins/php_unit.md) - `php_unit`
|
|
||||||
* [Shell](plugins/shell.md) - `shell`
|
|
||||||
* [Slack](plugins/slack_notify.md) - `slack_notify`
|
|
||||||
* [Technical Debt](plugins/technical_debt.md) - `technical_debt`
|
* [Technical Debt](plugins/technical_debt.md) - `technical_debt`
|
||||||
* [Security Checker](plugins/security_checker.md) - SensioLabs Security Checker Plugin (`security_checker`).
|
|
||||||
|
#### Databases
|
||||||
|
|
||||||
|
* [MySQL](plugins/mysql.md) - `mysql`
|
||||||
|
* [PostgreSQL](plugins/pgsql.md) - `pgsql`
|
||||||
|
* [SQLite](plugins/sqlite.md) - `sqlite`
|
||||||
|
|
||||||
|
#### Deployment
|
||||||
|
|
||||||
|
* [Mage](plugins/mage.md) - `mage`
|
||||||
|
* [Mage v3](plugins/mage3.md) - `mage3`
|
||||||
|
* [Phing](plugins/phing.md) - `phing`
|
||||||
|
* [Deployer](plugins/deployer.md) - `deployer`
|
||||||
|
|
||||||
|
#### Notifications
|
||||||
|
|
||||||
|
* [Campfire](plugins/campfire.md) - `campfire`
|
||||||
|
* [Email](plugins/email.md) - `email`
|
||||||
|
* FlowDock - `flowdock_notify`
|
||||||
|
* [HipChat](plugins/hipchat_notify.md) - `hipchat_notify`
|
||||||
|
* [IRC](plugins/irc.md) - `irc`
|
||||||
|
* [Slack](plugins/slack_notify.md) - `slack_notify`
|
||||||
* [XMPP](plugins/xmpp.md) - `xmpp`
|
* [XMPP](plugins/xmpp.md) - `xmpp`
|
||||||
|
|
||||||
|
#### Other
|
||||||
|
|
||||||
|
* [Clean Build](plugins/clean_build.md) - `clean_build`
|
||||||
|
* [Copy Build](plugins/copy_build.md) - `copy_build`
|
||||||
|
* [Env](plugins/env.md) - `env`
|
||||||
|
* Git - `git`
|
||||||
|
* [Grunt](plugins/grunt.md) - `grunt`
|
||||||
|
* Gulp - `gulp`
|
||||||
|
* [Package Build](plugins/package_build.md) - `package_build`
|
||||||
|
* [Phar](plugins/phar.md) - `phar`
|
||||||
|
* [Shell](plugins/shell.md) - `shell`
|
||||||
|
* Wipe - `wipe`
|
||||||
|
|
||||||
### Third-party plugins
|
### Third-party plugins
|
||||||
|
|
||||||
* [Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin) - Telegram plugin by
|
* [Telegram](https://github.com/php-censor/php-censor-telegram-plugin) - Telegram plugin by
|
||||||
[@LEXASOFT](https://github.com/LEXASOFT)
|
[@LEXASOFT](https://github.com/LEXASOFT)
|
||||||
* [Deployer](https://github.com/ket4yii/phpcensor-deployer-plugin) - Plugin for [Deployer](http://deployer.org) by
|
* [Deployer](https://github.com/php-censor/php-censor-deployer-plugin) - Plugin for [Deployer](http://deployer.org) by
|
||||||
[@ket4yii](https://github.com/ket4yii)
|
[@ketchoop](https://github.com/ketchoop)
|
||||||
|
|
Loading…
Reference in a new issue