Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Multiple Mautic instances - would that be a problem?

Suggested Composer package structure

http://github.com/mautic/mautic

The project as seen from the outside and where PR’s are made against. Like it is today

http://github.com/mautic/app or mautic/core?

Git subtree split from the github.com/mautic/mautic/app folder. To be discussed if we need to change this to core.

http://github.com/mautic/core-recommended

Separate package to guarantee that all of the dependencies from mautic/core

http://github.com/mautic/core-composer-scaffold

Composer plugin to make sure we can have some mautic knowledge similar to https://github.com/nickveenhof/mautic-core-composer-scaffold

It would all come together in a project called http://github.com/mautic/recommended-project similar to https://github.com/nickveenhof/mautic-project

This means we have the following as required packages in recommended-project

"mautic/core-composer-scaffold": "^4.0"

"mautic/core-recommended": "^4.0"

This also means that the following folders and files should be generated from within the scaffold resource folder in mautic/core

index.php (first time setup coming from app/assets/scaffold/files/index.php)
.htaccess (first time setup coming from app/assets/scaffold/files/.htaccess)
app → Core Mautic application coming from mautic/core
themes/contrib → themes downloaded by composer (public)
themes/contrib → themes downloaded by composer or custom written (private)
plugins/contrib → plugins downloaded by composer
plugins/custom → plugins from own packagists or custom code
media/ → all media files similar to today including the different folders
config/ → Configuration (user created)

This means the in the mautic/core (or mautic/app) we should also have folders such as app/plugins and app/themes where the core plugins and core themes live

Options considered

Mautic core/app folder name

Option 1:

Option 2:

Description

core

app

Pros and cons

(plus) In line with Drupal project and easier to learn from

(minus) a change in how mautic works today

(plus) The folder stays similar as it is today

(minus) Harder to map when learning from the Drupal project

Estimated cost

Status
colourRedYellow
titleLargeMedium

Status
colourYellow
titleMedium

...