Skip to content

Commit

Permalink
Fix 3.0 branch
Browse files Browse the repository at this point in the history
  • Loading branch information
anaelChardan committed Feb 5, 2019
1 parent 642f137 commit 7abd19a
Show file tree
Hide file tree
Showing 25 changed files with 82 additions and 81 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,6 @@
<!--- (<3 Thanks for taking the time to contribute! You're awesome! <3) --->

<!--- (If you've never contributed to this repository before, please read https://github.com/akeneo/pim-docs/blob/master/CONTRIBUTING.md) --->
<!--- (If you've never contributed to this repository before, please read https://github.com/akeneo/pim-docs/blob/3.0/CONTRIBUTING.md) --->

**Description**

Expand Down
14 changes: 7 additions & 7 deletions Dockerfile
Expand Up @@ -64,22 +64,22 @@ COPY build.sh /home/akeneo/pim-docs/build.sh
RUN chmod +x /home/akeneo/pim-docs/build.sh && \
#
# Download curent version
wget https://github.com/akeneo/pim-community-dev/archive/master.zip -P /home/akeneo/pim-docs/ && \
unzip /home/akeneo/pim-docs/master.zip -d /home/akeneo/pim-docs/ && \
wget https://github.com/akeneo/pim-community-dev/archive/3.0.zip -P /home/akeneo/pim-docs/ && \
unzip /home/akeneo/pim-docs/3.0.zip -d /home/akeneo/pim-docs/ && \
#
# Install Akeneo PIM
cd /home/akeneo/pim-docs/pim-community-dev-master/ && \
cd /home/akeneo/pim-docs/pim-community-dev-3.0/ && \
php -d memory_limit=3G /home/akeneo/pim-docs/composer.phar install --no-dev --no-suggest --ignore-platform-reqs && \
chown -R mysql:mysql /var/lib/mysql /var/run/mysqld && \
service mysql start && \
mysql -u root -e "CREATE DATABASE akeneo_pim" && \
mysql -u root -e "GRANT ALL PRIVILEGES ON akeneo_pim.* TO akeneo_pim@localhost IDENTIFIED BY 'akeneo_pim'" && \
cp /home/akeneo/pim-docs/pim-community-dev-master/app/config/parameters.yml.dist /home/akeneo/pim-docs/pim-community-dev-master/app/config/parameters.yml && \
cd /home/akeneo/pim-docs/pim-community-dev-master/ && php bin/console doctrine:schema:create --env=prod && \
cd /home/akeneo/pim-docs/pim-community-dev-master/ && php bin/console pim:installer:assets --env=prod && \
cp /home/akeneo/pim-docs/pim-community-dev-3.0/app/config/parameters.yml.dist /home/akeneo/pim-docs/pim-community-dev-3.0/app/config/parameters.yml && \
cd /home/akeneo/pim-docs/pim-community-dev-3.0/ && php bin/console doctrine:schema:create --env=prod && \
cd /home/akeneo/pim-docs/pim-community-dev-3.0/ && php bin/console pim:installer:assets --env=prod && \
service mysql stop && \
#
# Clean
rm -rf /root/.composer/cache && \
cd /home/akeneo/pim-docs/pim-community-dev-master/ && ls | grep -v "vendor\|web" | xargs rm -rf && \
cd /home/akeneo/pim-docs/pim-community-dev-3.0/ && ls | grep -v "vendor\|web" | xargs rm -rf && \
rm /var/lib/mysql/ibdata1 /var/lib/mysql/ib_logfile1 /var/lib/mysql/ib_logfile0
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -89,12 +89,12 @@ sed -i -e "s/^\(.*\)'versions': .*,\(.*\)$/\1'versions': ['$(git branch -l|grep
From the `./pim-docs` directory, run:

```bash
$ docker build . --tag pim-docs:master
$ docker build . --tag pim-docs:3.0
$ rm -rf pim-docs-build && mkdir pim-docs-build
$ docker run --rm \
-v $(pwd):/home/akeneo/pim-docs/data \
pim-docs:master \
./build.sh master --uid $(id -u) --gid $(id -g) --no-asset-check
pim-docs:3.0 \
./build.sh 3.0 --uid $(id -u) --gid $(id -g) --no-asset-check
```

The docs will be built into `./pim-docs-build`.
6 changes: 2 additions & 4 deletions cloud_edition/flexibility_mode/docs/composer_settings.rst
Expand Up @@ -30,13 +30,11 @@ Composer settings
"repositories": [
{
"type": "vcs",
"url": "https://github.com/akeneo/pim-community-dev.git",
"branch": "master"
"url": "https://github.com/akeneo/pim-community-dev.git"
},
{
"type": "vcs",
"url": "ssh://git@distribution.akeneo.com:443/pim-enterprise-dev-<who_i_am>.git",
"branch": "master"
"url": "ssh://git@distribution.akeneo.com:443/pim-enterprise-dev-<who_i_am>.git"
}
],
Expand Down
14 changes: 7 additions & 7 deletions contribute_to_pim/contribution_guide.rst
Expand Up @@ -109,7 +109,7 @@ topic branch:

.. code-block:: bash
$ git checkout -b BRANCH_NAME master
$ git checkout -b BRANCH_NAME 3.0
.. tip::

Expand Down Expand Up @@ -231,11 +231,11 @@ while to finish your changes):

.. code-block:: bash
$ git checkout master
$ git checkout 3.0
$ git fetch upstream
$ git merge upstream/master
$ git merge upstream/3.0
$ git checkout BRANCH_NAME
$ git rebase master
$ git rebase 3.0
When doing the ``rebase`` command, you might have to fix merge conflicts.
``git status`` will show you the *unmerged* files. Resolve all the conflicts,
Expand Down Expand Up @@ -346,11 +346,11 @@ Rework your Patch
~~~~~~~~~~~~~~~~~

Based on the feedback on the pull request, you might need to rework your
patch. Before re-submitting the patch, rebase with ``upstream/master``, don't merge; and force the push to the origin:
patch. Before re-submitting the patch, rebase with ``upstream/3.0``, don't merge; and force the push to the origin:

.. code-block:: bash
$ git rebase -f upstream/master
$ git rebase -f upstream/3.0
$ git push --force origin BRANCH_NAME
.. note::
Expand All @@ -364,7 +364,7 @@ convert many commits to one commit. To do this, use the rebase command:

.. code-block:: bash
$ git rebase -i upstream/master
$ git rebase -i upstream/3.0
$ git push --force origin BRANCH_NAME
After you type this command, an editor will popup showing a list of commits:
Expand Down
2 changes: 1 addition & 1 deletion contribute_to_pim/documentation.rst
Expand Up @@ -23,7 +23,7 @@ For typo / quick fixes you can directly submit a `PullRequest`_.

To test the rendering of the documentation you can follow this `HowTo`_.

.. _HowTo: https://github.com/akeneo/pim-docs/blob/master/README.md
.. _HowTo: https://github.com/akeneo/pim-docs/blob/3.0/README.md

Once your Pull Request is merged, don't hesitate to claim your badge "Core contributor" on `Badger platform <http://badger.akeneo.com/login/>`_!

Expand Down
12 changes: 6 additions & 6 deletions contribute_to_pim/tests/establishing_decorator_pattern.rst
Expand Up @@ -86,7 +86,7 @@ Navigate And Change The Current Page
}
Selenium will know which URL to go to thanks to `the protected $path attribute
<https://github.com/akeneo/pim-community-dev/blob/master/tests/legacy/features/Context/Page/Role/Edit.php#L19>`_
<https://github.com/akeneo/pim-community-dev/blob/3.0/tests/legacy/features/Context/Page/Role/Edit.php#L19>`_
contained in *Context\\Page\\Role\\Edit*.

You may notice that this Gherkin method still uses the old implementation of Behat in Akeneo PIM.
Expand All @@ -102,7 +102,7 @@ This organization is very helpful to quickly find the context you are looking fo

We are working on permissions that are localized in the system main menu. So let's see the
`\\Pim\\Behat\\Context\\Domain\\System\\PermissionsContext
<https://github.com/akeneo/pim-community-dev/blob/master/tests/legacy/features/Behat/Context/Domain/System/PermissionsContext.php>`_.
<https://github.com/akeneo/pim-community-dev/blob/3.0/tests/legacy/features/Behat/Context/Domain/System/PermissionsContext.php>`_.

.. image:: images/PermissionsContext.png

Expand Down Expand Up @@ -149,12 +149,12 @@ Pages
_____

The current page is `Context\\Page\\Role\\Edit
<https://github.com/akeneo/pim-community-dev/blob/master/tests/legacy/features/Context/Page/Role/Edit.php>`_.
<https://github.com/akeneo/pim-community-dev/blob/3.0/tests/legacy/features/Context/Page/Role/Edit.php>`_.

When you call *Pim\\Behat\\Context\\NavigationContext->getCurrentPage()* the method will match "Role edit" to
*return new Context\\Page\\Role\\Edit()*. That's why all of our pages are located in a folder named after the name of
the Entity. In this folder, each action has its dedicated page such as Index.php, Creation.php, Edit.php as you can see
in the `Role folder <https://github.com/akeneo/pim-community-dev/blob/master/tests/legacy/features/Context/Page/Role>`_ for example.
in the `Role folder <https://github.com/akeneo/pim-community-dev/blob/3.0/tests/legacy/features/Context/Page/Role>`_ for example.

.. image:: images/edit.png

Expand Down Expand Up @@ -247,7 +247,7 @@ The name of the sub-folder is only the representative name of the element, no pr
have to be suffixed by "Decorator" like *DecoratedElementDecorator*.

The `Pim\\Behat\\Decorator\\Permission\\PermissionDecorator
<https://github.com/akeneo/pim-community-dev/blob/master/tests/legacy/features/Behat/Context/Domain/System/PermissionsContext.php>`_
<https://github.com/akeneo/pim-community-dev/blob/3.0/tests/legacy/features/Behat/Context/Domain/System/PermissionsContext.php>`_
adds behaviors to an Element to be able to navigate between groups and grant or revoke permissions for resources or groups.

.. image:: images/decorator.png
Expand Down Expand Up @@ -303,7 +303,7 @@ The method *$this->find()* is neither in the decorator nor in the abstract class
That's how we can call methods from the Element class inside decorators. And obviously, that's why all decorators must
extend `Pim\\Behat\\Decorator\\ElementDecorator
<https://github.com/akeneo/pim-community-dev/blob/master/tests/legacy/features/Behat/Decorator/ElementDecorator.php>`_.
<https://github.com/akeneo/pim-community-dev/blob/3.0/tests/legacy/features/Behat/Decorator/ElementDecorator.php>`_.

.. note::

Expand Down
2 changes: 1 addition & 1 deletion contribute_to_pim/tests/index.rst
Expand Up @@ -2,7 +2,7 @@ How behavior tests are architectured in the PIM?
================================================


The PIM comes with a set of Behat scenarios: https://github.com/akeneo/pim-community-dev/blob/master/tests/legacy/features
The PIM comes with a set of Behat scenarios: https://github.com/akeneo/pim-community-dev/blob/3.0/tests/legacy/features

.. warning::

Expand Down
2 changes: 1 addition & 1 deletion design_pim/guides/create_a_reference_data_crud.rst
Expand Up @@ -4,4 +4,4 @@ How to create the UI to manage a Reference Data
.. note::
The documentation of this cookbook is available on the extension `CustomEntityBundle`_.

.. _CustomEntityBundle: https://github.com/akeneo-labs/CustomEntityBundle/blob/master/docs/index.md
.. _CustomEntityBundle: https://github.com/akeneo-labs/CustomEntityBundle/blob/3.0/docs/index.md
2 changes: 1 addition & 1 deletion import_and_export_data/formats/attribute.rst
Expand Up @@ -10,7 +10,7 @@ The import/export file follows this data structure:
:file: examples/attribute_properties.csv
:delim: ;

.. _MeasureBundle measures: https://github.com/akeneo/MeasureBundle/blob/master/Resources/config/measure.yml
.. _MeasureBundle measures: https://github.com/akeneo/MeasureBundle/blob/3.0/Resources/config/measure.yml

.. note::

Expand Down
4 changes: 2 additions & 2 deletions import_and_export_data/simple-import.rst
@@ -1,8 +1,8 @@
How import works
================

.. _minimal: https://github.com/akeneo/pim-community-dev/tree/master/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/minimal
.. _icecat: https://github.com/akeneo/pim-community-dev/tree/master/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/icecat_demo_dev
.. _minimal: https://github.com/akeneo/pim-community-dev/tree/3.0/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/minimal
.. _icecat: https://github.com/akeneo/pim-community-dev/tree/3.0/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/icecat_demo_dev

At any time, a set of data can be imported: products, attributes, users, etc.

Expand Down
4 changes: 2 additions & 2 deletions install_pim/docker/installation_docker.rst
Expand Up @@ -48,7 +48,7 @@ This is achieved by `bind mounting <https://docs.docker.com/storage/bind-mounts/
.. note::

The following compose file example is intentionally incomplete, focusing on cache directories only.
Check the complete file directly `in the PIM <https://github.com/akeneo/pim-community-dev/blob/master/docker-compose.yml>`_.
Check the complete file directly `in the PIM <https://github.com/akeneo/pim-community-dev/3.0/master/docker-compose.yml>`_.

.. code-block:: yaml
Expand Down Expand Up @@ -134,7 +134,7 @@ Here is a ``docker-compose.override.yml`` example:
Be aware that it is currently not possible to replace array values in the override. You can read more here: https://docs.docker.com/compose/extends/#adding-and-overriding-configuration.

This is why the mapping of the Apache port is already present in `docker-compose.yml <https://github.com/akeneo/pim-community-dev/blob/master/docker-compose.yml#L46>`_, as this mapping is mandatory to access the PIM from a web browser.
This is why the mapping of the Apache port is already present in `docker-compose.yml <https://github.com/akeneo/pim-community-dev/blob/3.0/docker-compose.yml#L46>`_, as this mapping is mandatory to access the PIM from a web browser.
It is configurable through an environment variable, wo you will not have any conflicts having several PIM running in parallel. Just copy the file ```.env.dist``` as ```.env``` and set the port you want to access Apache on.

If you intend to run behat tests, create on your host a folder ``/tmp/behat/screenshots`` (or anywhere else according to your compose file) with full read/write access to your user.
Expand Down
4 changes: 2 additions & 2 deletions install_pim/manual/installation_archive.rst.inc
Expand Up @@ -5,13 +5,13 @@ Extracting the archive
:linenos:

$ mkdir -p /path/to/installation
$ tar -xvzf pim-community-standard-v2.0-latest-icecat.tar.gz -C /path/to/installation/
$ tar -xvzf pim-community-standard-v3.0-latest-icecat.tar.gz -C /path/to/installation/

.. note::
Replace */path/to/installation* by the path to the directory where you want to install the PIM.

.. note::
* Replace *pim-community-standard-v2.0-latest-icecat.tar.gz* by the location and the name of the archive you have downloaded from https://www.akeneo.com/download
* Replace *pim-community-standard-v3.0-latest-icecat.tar.gz* by the location and the name of the archive you have downloaded from https://www.akeneo.com/download

.. note::
The PIM will be extracted in the folder /path/to/installation/pim-community-standard.
Expand Down
4 changes: 2 additions & 2 deletions install_pim/manual/installation_archive_ee.rst.inc
Expand Up @@ -5,13 +5,13 @@ Extracting the archive
:linenos:

$ mkdir -p /path/to/installation
$ tar -xvzf pim-enterprise-standard-v2.3.tar.gz -C /path/to/installation/
$ tar -xvzf pim-enterprise-standard-v3.0.tar.gz -C /path/to/installation/

.. note::
Replace */path/to/installation* by the path to the directory where you want to install the PIM.

.. note::
Replace *pim-enterprise-standard-v2.3.tar.gz* by the location and the name of the archive you have downloaded from the Portal. Instructions on how to download this archive are available `from the Help Center <https://help.akeneo.com/portal/articles/get-akeneo-pim-enterprise-archive.html?utm_source=akeneo-docs&utm_campaign=installation_archive>`_
Replace *pim-enterprise-standard-v3.0.tar.gz* by the location and the name of the archive you have downloaded from the Portal. Instructions on how to download this archive are available `from the Help Center <https://help.akeneo.com/portal/articles/get-akeneo-pim-enterprise-archive.html?utm_source=akeneo-docs&utm_campaign=installation_archive>`_

.. note::
The PIM will be extracted in the folder /path/to/installation/pim-enterprise-standard.
Expand Down
4 changes: 2 additions & 2 deletions install_pim/manual/installation_ce_archive.rst
Expand Up @@ -15,7 +15,7 @@ You can also download them directly from the command line:
.. code-block:: bash
:linenos:
$ wget https://download.akeneo.com/pim-community-standard-v2.3-latest-icecat.tar.gz #for icecat version
$ wget https://download.akeneo.com/pim-community-standard-v2.3-latest.tar.gz #for minimal version
$ wget https://download.akeneo.com/pim-community-standard-v3.0-latest-icecat.tar.gz #for icecat version
$ wget https://download.akeneo.com/pim-community-standard-v3.0-latest.tar.gz #for minimal version
.. include:: ./installation_archive.rst.inc
Expand Up @@ -8,7 +8,7 @@ on selected products.
Prerequisite
------------
The mass edit action uses the `BatchBundle
<https://github.com/akeneo/pim-community-dev/blob/master/src/Akeneo/Tool/Bundle/BatchBundle>`_ in order to run mass edit in the background. Readers and Writers are already
<https://github.com/akeneo/pim-community-dev/blob/3.0/src/Akeneo/Tool/Bundle/BatchBundle>`_ in order to run mass edit in the background. Readers and Writers are already
created so in this cookbook we will focus on how to create a Mass Edit Action and create a Processor.
For more information on how to create Jobs, Readers, Processors, or Writers please see :doc:`/import_and_export_data/index`.

Expand Down
2 changes: 1 addition & 1 deletion manipulate_pim_data/non-product/create.rst
@@ -1,7 +1,7 @@
How to Create Non-Product Objects
=================================

.. _SimpleFactoryInterface: https://github.com/akeneo/pim-community-dev/blob/master/src/Akeneo/Tool/Component/StorageUtils/Factory/SimpleFactoryInterface.php
.. _SimpleFactoryInterface: https://github.com/akeneo/pim-community-dev/blob/3.0/src/Akeneo/Tool/Component/StorageUtils/Factory/SimpleFactoryInterface.php

To create common objects, we rely on different methods depending on the complexity of the object. There are some examples on how to use these services.

Expand Down
17 changes: 10 additions & 7 deletions migrate_pim/index.rst
Expand Up @@ -19,14 +19,14 @@ When our maintenance team works on issues, they take extreme care to avoid any b
Akeneo PIM CE changelog is available on our GitHub repository:

* Go to our `Community Repository <https://github.com/akeneo/pim-community-dev/>`_.
* Select your branch in the drop down menu, for instance select 2.3 branch.
* Then scroll down the page, and select the desired Changelog in the list, for instance `Changelog 2.3 version <https://github.com/akeneo/pim-community-dev/blob/2.3/CHANGELOG-2.3.md>`_.
* Select your branch in the drop down menu, for instance select 3.0 branch.
* Then scroll down the page, and select the desired Changelog in the list, for instance `Changelog 3.0 version <https://github.com/akeneo/pim-community-dev/blob/3.0/CHANGELOG-3.0.md>`_.

.. note::

Akeneo provides 2 changelogs: one for CE edition available the Community repo and one for EE edition which is only available in the latest archive. If you want to check the latest fixes for the Enterprise Edition, download the last archive or contact us.

In the following example, Akeneo PIM version 2.3.10 has just been released and we are using an Akeneo PIM version 2.3.9.
In the following example, Akeneo PIM version 3.0.10 has just been released and we are using an Akeneo PIM version 3.0.9.

**Community Edition**

Expand All @@ -40,7 +40,7 @@ Be aware that your composer.json won't be updated and some dependencies might be

You have to check whether the latest composer.json is different from your own. In this case you should backup your current composer.json and download the newest one beforehand.

Double check in the output of this command that the 2.3.10 version has been fetched, you can also check it by using the following command:
Double check in the output of this command that the 3.0.10 version has been fetched, you can also check it by using the following command:

.. code-block:: bash
Expand Down Expand Up @@ -87,12 +87,12 @@ To upgrade, please change the composer.json to:
{
...
"akeneo/pim-enterprise-dev": "2.3.10",
"akeneo/pim-community-dev": "2.3.10",
"akeneo/pim-enterprise-dev": "3.0.10",
"akeneo/pim-community-dev": "3.0.10",
...
}
We always tag both community and enterprise versions with aligned version numbers, be sure to use the exact same version for CE and EE, for instance, a EE 2.3.10 fix may depend on CE 2.3.10.
We always tag both community and enterprise versions with aligned version numbers, be sure to use the exact same version for CE and EE, for instance, a EE 3.0.10 fix may depend on CE 3.0.10.

Using the exact patch version will avoid any local composer cache issue.

Expand Down Expand Up @@ -147,6 +147,7 @@ Here are the migration guides:

**Community Edition**

* `From v2.3 to v3.0`_
* `From v2.2 to v2.3`_
* `From v2.1 to v2.2`_
* `From v2.0 to v2.1`_
Expand All @@ -158,6 +159,7 @@ Here are the migration guides:
* `From v1.1 to v1.2`_
* `From v1.0 to v1.1`_

.. _From v2.3 to v3.0: https://github.com/akeneo/pim-community-standard/blob/3.0/UPGRADE-3.0.md
.. _From v2.2 to v2.3: https://github.com/akeneo/pim-community-standard/blob/master/UPGRADE-2.3.md
.. _From v2.1 to v2.2: https://github.com/akeneo/pim-community-standard/blob/master/UPGRADE-2.2.md
.. _From v2.0 to v2.1: https://github.com/akeneo/pim-community-standard/blob/master/UPGRADE-2.1.md
Expand All @@ -175,6 +177,7 @@ Standard Enterprise Edition (EE) archives are available from `the Portal <https:

Then, follow the migration guides located in your archive to upgrade your project.

* From EE v2.3 to EE v3.0: UPGRADE-3.0.md
* From EE v2.2 to EE v2.3: UPGRADE-2.3.md
* From EE v2.1 to EE v2.2: UPGRADE-2.2.md
* From EE v2.0 to EE v2.1: UPGRADE-2.1.md
Expand Down
2 changes: 1 addition & 1 deletion technical_architecture/best_practices/core/behat.rst
@@ -1,7 +1,7 @@
Setup Behat
===========

The PIM comes with a set of Behat scenarios: https://github.com/akeneo/pim-community-dev/blob/master/tests/legacy/features
The PIM comes with a set of Behat scenarios: https://github.com/akeneo/pim-community-dev/blob/3.0/tests/legacy/features

These scenarios allow to:

Expand Down

0 comments on commit 7abd19a

Please sign in to comment.