From 80255051a4286f3e9a5cd369a429732ec9b86bbb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20R?= Date: Mon, 14 Dec 2015 12:41:59 +0100 Subject: [PATCH 1/8] Update INSTALL.md --- INSTALL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index bc378da505..77156eb70b 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -53,8 +53,8 @@ Options: - ``: Optional, *if omitted you'll get latest stable*, examples for specifying: - - `1.0.0@beta`: Example of getting latests 1.0.0 beta - - `v1.0.0-beta5`: example of picking a specific release/tag + - `~1.0.0`: Example of getting latests 1.0.x release, recommended + - `v1.0.0-beta5`: example of picking a specific tag - `dev-master`: to get current development version (pre release) `master` branch - For core development: Add '--prefer-source' to get full git clones, and remove '--no-dev' to get things like phpunit and behat installed. - Further reading: https://getcomposer.org/doc/03-cli.md#create-project From 00ecd9bf8107cf27ed0789be0ea94260f969664b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andre=CC=81=20R?= Date: Mon, 14 Dec 2015 15:09:46 +0100 Subject: [PATCH 2/8] [Doc] Increse suggested nginx client_max_body_size to 20m --- doc/nginx/etc/nginx/sites-available/mysite.com | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/nginx/etc/nginx/sites-available/mysite.com b/doc/nginx/etc/nginx/sites-available/mysite.com index ccc1fa1a5e..a2fc9accf5 100644 --- a/doc/nginx/etc/nginx/sites-available/mysite.com +++ b/doc/nginx/etc/nginx/sites-available/mysite.com @@ -21,7 +21,7 @@ server { include ez_params.d/ez_rewrite_params; # upload max size - client_max_body_size 2m; + client_max_body_size 20m; location / { location ~ ^/app\.php(/|$) { From c6d715dfa5c3f15a75f248ff60ed31928e1125c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andre=CC=81=20R?= Date: Mon, 14 Dec 2015 15:48:49 +0100 Subject: [PATCH 3/8] [Doc] Update doc links and remove obsolete legacy parts --- GETTING_STARTED.md | 60 +--------------------------------------------- INSTALL.md | 2 +- MODULE_CREATION.md | 11 --------- README.md | 2 +- 4 files changed, 3 insertions(+), 72 deletions(-) delete mode 100644 MODULE_CREATION.md diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index ebf9dc00d1..290702ad2c 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -1,4 +1,4 @@ -# Hacking on eZ Platform +# Getting started on eZ Platform eZ Platform is built on top of **Symfony2 full stack framework** (version **2.x**), and as such all guidelines, requirements and best practices remain the same. @@ -9,26 +9,6 @@ in order to get the basics. Note: Section below is out-of-date but represent some hints on how to be learn more about contributing to eZ Platform. For introduction to *using* eZ Platform, please check our [online doc](doc.ez.no). -## Demo bundle -> "Bundle" is the name used for an extension in Symfony. - -A demo bundle, [EzDemoBundle](https://github.com/ezsystems/ezpublish-community/tree/master/src/EzSystems/DemoBundle), is provided -in the *src/* directory under the *EzSystems* namespace and, among others, provides implementation for the demo design. -This demo bundle already exposes [some routes](https://github.com/ezsystems/ezpublish-community/blob/master/src/EzSystems/DemoBundle/Resources/config/routing.yml) -allowing to make some tests and hacking. - -The most interesting routes for a start are : - -- **eZTest**: Loads a content via the Public API and displays it. This content is expected to be a very simple folder with - *name* and *description* Field Definitions (formerly *content class attributes*). -- **eZTestWithLegacy**: Includes a legacy template in a new one. - -> Warning: Public API still supports a limited number of Field Types (formerly *datatypes*), and as such you will probably get exceptions -> regarding that. -> -> To be able to show some content, please create a simple Content Type (formerly *content class*) via the admin interface -> (you can access it from your eZ Platform installation like you already did before). - ## Guidelines and features available ### Generating a bundle eZ Platform comes with [SensioGeneratorBundle](http://symfony.com/doc/current/bundles/SensioGeneratorBundle/index.html). @@ -104,41 +84,3 @@ From a Twig template, it is possible to render a content with a sub-request: ```jinja {% render "ez_content:viewLocation" with {"locationId": 123, "viewMode": "full"} %} ``` - -### Legacy templates inclusion -It is possible to include old templates (**.tpl*) into new ones: - -```jinja -{# Twig template #} -{# Following code will include my/old_template.tpl, exposing $someVar variable in it #} -{% include "design:my/old_template.tpl" with {"someVar": "someValue"} %} -``` - -> **Note** -> -> Content/Location objects from the Public API are converted into eZContentObject/eZContentObjectTreeNode objects (re-fetched) - -### Run legacy PHP code -The new kernel still relies on eZ Publish legacy kernel and runs it when needed inside an isolated PHP closure, making it sandboxed. - -It is however still possible to run some PHP code inside that sandbox through the `runCallback()` method. - -```php -getLegacyKernel()->runCallback( - function () use ( $settingName, $test ) - { - // Here you can reuse $settingName and $test variables inside the legacy context - $ini = eZINI::instance( 'someconfig.ini' ); - return $ini->variable( 'SomeSection', $settingName ); - } -); -``` -> `runCallback()` can also take a 2nd argument. Setting to `true` avoids to re-initialize the legacy kernel environment after your call. - diff --git a/INSTALL.md b/INSTALL.md index 77156eb70b..e3b07607f9 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -8,7 +8,7 @@ ## Prerequisite These instructions assume you have technical knowledge and have already installed PHP, web server & - *a database server* needed for this software. For further information on requirements [see online doc](https://doc.ez.no/display/EZP/Requirements) + *a database server* needed for this software. For further information on requirements [see online doc](https://doc.ez.no/display/TECHDOC/Requirements) **Before you start**: - Create Database: Installation will ask you for credentials/details for which database to use diff --git a/MODULE_CREATION.md b/MODULE_CREATION.md deleted file mode 100644 index b1086571a2..0000000000 --- a/MODULE_CREATION.md +++ /dev/null @@ -1,11 +0,0 @@ -Creating a module -================= - -Documentation -------------- - -eZ Platform relying on Symfony2 and twig, modules are created by using -[Bundles](http://symfony.com/doc/current/bundles/). - -The best way to learn on how to interact within the new Symfony stack is to -read the [available documentation](http://symfony.com/doc/current/book/page_creation.html). diff --git a/README.md b/README.md index d7422f68ee..907c8914a9 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ features for editorial teams and media companies, 100% built on top of *eZ Platf For installation & upgrade instructions, see [INSTALL.md](https://github.com/ezsystems/ezplatform/blob/master/INSTALL.md). ## Requirements -**eZ Platform** currently has the same requirements as *eZ Publish Platform 5.4*, further details on the [5.4 requirements](https://doc.ez.no/display/EZP/Requirements+5.4) page. +Full requirements can be found on the [Requirements](https://doc.ez.no/display/TECHDOC/Requirements) page. *TL;DR: minimum PHP 5.4.4 and higher, using mod_php or php-fpm.* From 3b5426a2ff9b38b35854ef1b8b3845c3d78ac6b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andre=CC=81=20R?= Date: Mon, 14 Dec 2015 15:50:52 +0100 Subject: [PATCH 4/8] [Composer] Set Symfony version to ~2.7.0 for now --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 3aaeea7cd6..5060cbf8a3 100644 --- a/composer.json +++ b/composer.json @@ -17,7 +17,7 @@ }, "require": { "php": ">=5.4.4", - "symfony/symfony": "~2.7", + "symfony/symfony": "~2.7.0", "twig/extensions": "~1.0", "symfony/assetic-bundle": "~2.3", "symfony/swiftmailer-bundle": "~2.3", From 6eb59364e7c233a2262e2f8289be08fecf9c9c7d Mon Sep 17 00:00:00 2001 From: Krzysztof Rajzer Date: Mon, 14 Dec 2015 15:56:44 +0100 Subject: [PATCH 5/8] EZS-341: eZ Studio Installation Guide --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b3ad1702a0..88777fbfae 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ http://ez.no/Blog/What-to-Expect-from-eZ-Studio-and-eZ-Platform For installation & upgrade instructions, see [INSTALL.md](https://github.com/ezsystems/ezstudio/blob/master/INSTALL.md). ## Requirements -Full requirements can be found on the [Requirements](https://doc.ez.no/display/TECHDOC/Requirements) page. +**eZ Studio** currently has the same requirements as *eZ Platform*, further details on the [Requirements](https://doc.ez.no/display/TECHDOC/Requirements) page. *TL;DR: minimum PHP 5.4.4 and higher, using mod_php or php-fpm.* From c0e48313defe64d177abdb68f8aee21503b0dfc3 Mon Sep 17 00:00:00 2001 From: Krzysztof Rajzer Date: Mon, 14 Dec 2015 16:21:23 +0100 Subject: [PATCH 6/8] EZS-341: eZ Studio Installation Guide --- INSTALL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 2b018427d6..0597efd057 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -26,7 +26,7 @@ `parameters.yml` contains settings for your database, mail system, and optionally [Solr](http://lucene.apache.org/solr/) if `search_engine` is configured as `solr`, as opposed to default `legacy` *(a limited database powered search engine)*. - A. **Extract archive** (tar/zip) *from http://share.ez.no/downloads/downloads* + A. **Extract archive** (tar/zip) *from https://support.ez.no/Downloads* Extract the eZ Studio archive to a directory, then execute post install scripts: @@ -135,7 +135,7 @@ You may now complete the eZ Studio installation with ezplatform:install command, example of use: ```bash - $ php -d memory_limit=-1 app/console ezplatform:install --env prod clean + $ php -d memory_limit=-1 app/console ezplatform:install --env prod demo ``` **Note**: Password for the generated `admin` user is `publish`, this name and password is needed when you would like to login to backend Studio UI. Future versions will prompt you for a unique password during installation. From 59f9e861dd9811a96453d367a8b98be0d10ca5f9 Mon Sep 17 00:00:00 2001 From: Krzysztof Rajzer Date: Mon, 14 Dec 2015 17:33:07 +0100 Subject: [PATCH 7/8] Revert "EZS-341: eZ Studio Installation Guide" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 88777fbfae..b3ad1702a0 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ http://ez.no/Blog/What-to-Expect-from-eZ-Studio-and-eZ-Platform For installation & upgrade instructions, see [INSTALL.md](https://github.com/ezsystems/ezstudio/blob/master/INSTALL.md). ## Requirements -**eZ Studio** currently has the same requirements as *eZ Platform*, further details on the [Requirements](https://doc.ez.no/display/TECHDOC/Requirements) page. +Full requirements can be found on the [Requirements](https://doc.ez.no/display/TECHDOC/Requirements) page. *TL;DR: minimum PHP 5.4.4 and higher, using mod_php or php-fpm.* From cefd154c8e5eec9c5f5abc41214517a398f5b1cf Mon Sep 17 00:00:00 2001 From: Krzysztof Rajzer Date: Tue, 15 Dec 2015 14:29:15 +0100 Subject: [PATCH 8/8] EZS-341: eZ Studio Installation Guide Updated the final public download URL. --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 0597efd057..2128cb4f19 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -26,7 +26,7 @@ `parameters.yml` contains settings for your database, mail system, and optionally [Solr](http://lucene.apache.org/solr/) if `search_engine` is configured as `solr`, as opposed to default `legacy` *(a limited database powered search engine)*. - A. **Extract archive** (tar/zip) *from https://support.ez.no/Downloads* + A. **Extract archive** (tar/zip) *from https://support.ez.no/Downloads/eZ-Studio-15.12* Extract the eZ Studio archive to a directory, then execute post install scripts: