Improved README and Docs

This commit is contained in:
Dmitry Khomutov 2017-02-20 20:57:47 +07:00
parent 3176111c91
commit 23aa5d7cc7
No known key found for this signature in database
GPG key ID: 7EB36C9576F9ECB9
4 changed files with 27 additions and 15 deletions

View file

@ -26,7 +26,7 @@ Change Log
* **Fixed multiple install command execution (Now admin and project group don't duplicate).** * **Fixed multiple install command execution (Now admin and project group don't duplicate).**
* Added yaml highlight for build config in project page. * Added yaml highlight for build config in project page.
* Improved Gogs support. Thanks to @vinpel. PullRequest #18. * Improved Gogs support. Thanks to [@vinpel](https://github.com/vinpel). PullRequest #18.
* Improved dashboard UI. * Improved dashboard UI.
@ -56,9 +56,9 @@ cd ./php-censor.local
``` ```
* Added caching for public build status badge. Issue #15. * Added caching for public build status badge. Issue #15.
* Added build from Gogs (build type and webhook). The feature is based on @denji`s code. Issue #13. * Added build from Gogs (build type and webhook). The feature is based on [@denji](https://github.com/denji)'s code. Issue #13.
* Improved Codeception plugin. Thanks to @vinpel. PullRequest #16. * Improved Codeception plugin. Thanks to [@vinpel](https://github.com/vinpel). PullRequest #16.
* Updated french translation. Thanks to @vinpel. PullRequest #16. * Updated french translation. Thanks to [@vinpel](https://github.com/vinpel). PullRequest #16.
* Fixed init language. Issue #9. * Fixed init language. Issue #9.
@ -147,7 +147,8 @@ php-censor:
mail_attribute: mail mail_attribute: mail
``` ```
If you enter by new LDAP-user, the record in the DB will be created automatically. The basement of the feature is @Adirelle and @dzolotov code. If you enter by new LDAP-user, the record in the DB will be created automatically. The basement of the feature is
[@Adirelle](https://github.com/Adirelle) and [@dzolotov](https://github.com/dzolotov) code.
* **Unified application configuration (app/config.yml) authentication options** * **Unified application configuration (app/config.yml) authentication options**

View file

@ -29,24 +29,25 @@ More [screenshots](docs/en/screenshots.md).
System requirements System requirements
------------------- -------------------
* Unix-like OS (**Windows isn't supported**) * Unix-like OS (**Windows isn't supported**);
* PHP 5.6+ (with OpenSSL support and enabled functions: `exec()`, `shell_exec()` and `proc_open()`) * PHP 5.6+ (with OpenSSL support and enabled functions: `exec()`, `shell_exec()` and `proc_open()`);
* Web-server (Nginx or Apache2) * Web-server (Nginx or Apache2);
* Database (MySQL/MariaDB or PostgreSQL) * Database (MySQL/MariaDB or PostgreSQL);
* Beanstalkd queue (Optional) * Beanstalkd queue (Optional);
Features Features
-------- --------
* Clone project from Github, Bitbucket, Gitlab, Git, Mercurial, SVN or from local directory; * Clone project from Github, Bitbucket, Gitlab, Git, Mercurial, SVN or from local directory;
* Set up and tear down database tests for PostgreSQL, MySQL or SQLite; * Set up and tear down database tests for [PostgreSQL](docs/plugins/pgsql.md), [MySQL](docs/plugins/mysql.md) or
[SQLite](docs/plugins/sqlite.md);
* Install Composer dependencies; * Install [Composer](docs/plugins/composer.md) dependencies;
* Run tests for PHPUnit, Atoum, Behat, Codeception and PHPSpec; * Run tests for PHPUnit, Atoum, Behat, Codeception and PHPSpec;
@ -56,7 +57,9 @@ PHPMessDetect, PHPTalLint and TechnicalDept;
* Run through any combination of the other [supported plugins](docs/en/README.md), including Campfire, CleanBuild, * Run through any combination of the other [supported plugins](docs/en/README.md), including Campfire, CleanBuild,
CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe; CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe;
* Send notifications on Email, XMPP, Slack, IRC, Flowdock and HipChat; * 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;
Installing Installing
---------- ----------

View file

@ -27,6 +27,8 @@ Using PHP Censor
Plugins Plugins
------- -------
### Internal plugins
* [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` * [Campfire](plugins/campfire.md) - `campfire`
@ -61,3 +63,7 @@ Plugins
* [Slack](plugins/slack_notify.md) - `slack_notify` * [Slack](plugins/slack_notify.md) - `slack_notify`
* [Technical Debt](plugins/technical_dept.md) - `technical_debt` * [Technical Debt](plugins/technical_dept.md) - `technical_debt`
* [XMPP](plugins/xmpp.md) - `xmpp` * [XMPP](plugins/xmpp.md) - `xmpp`
### Third-party plugins
* [Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin) - Telegram plugin by [@LEXASOFT](https://github.com/LEXASOFT)

View file

@ -1,7 +1,8 @@
Automatically building commits pushed to GitHub Automatically building commits pushed to GitHub
=============================================== ===============================================
If you would like your builds to run automatically whenever there is a commit or other similar activity in your GitHub repository, perform the following steps: If you would like your builds to run automatically whenever there is a commit or other similar activity in your GitHub
repository, perform the following steps:
1. Log into PHP Censor. 1. Log into PHP Censor.
2. Click on your GitHub project. 2. Click on your GitHub project.
@ -11,4 +12,5 @@ If you would like your builds to run automatically whenever there is a commit or
6. Click on "Webhooks & Services". 6. Click on "Webhooks & Services".
7. Add your web hook link you copied above, and specify when you would like it to run. 7. Add your web hook link you copied above, and specify when you would like it to run.
8. Add the public key for the project in PHP Censor to the deploy keys for the repository on GitHub. 8. Add the public key for the project in PHP Censor to the deploy keys for the repository on GitHub.
9. Verify that the initial test delivery was successful. If not, make sure that your PHP Censor machine is reachable from the internet. 9. Verify that the initial test delivery was successful. If not, make sure that your PHP Censor machine is reachable
from the internet.