-
-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
194 changed files
with
2,332 additions
and
1,434 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Upgrade Guide | ||
|
||
Please check the [Upgrade_Notes](02_Upgrade_Notes.md) Guide for changes and for potential breaking changes. | ||
|
||
We follow similar approach to updates as Pimcore does. So always update to the latest Minor release version first before | ||
updating to the next Major release version. This means that if you are on 3.2.1 and want to update to 4.0, you should update | ||
to the latest 3.2.x release first and then update to 4.0 or 4.1. | ||
|
||
## Migration Files | ||
To keep things tidy, we remove migration between major versions. This means that if you are on 3.2.1 and you update to 4.0 | ||
directly, you might miss migrations. Always update to the latest Minor release version first before updating to the next Major! | ||
|
||
This also means that if you do major updates, you will have old migrations in your Database. You can manually remove those | ||
if you want to keep your Migrations Table clean. | ||
|
||
If you already updated the major version and recognize that some migrations from your previous version to latest minor release version are missing, you can compare the database structure via | ||
`bin/console doctrine:schema:update --dump-sql` | ||
Please manually review the SQL statements before executing |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
35 changes: 35 additions & 0 deletions
35
docs/03_Development/15_Frontend_Bundle/02_Best_Practices.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Best Practices for Frontend in CoreShop | ||
|
||
We learned a lot over the years and want to share our best practices with you. This guide will help you to get the most | ||
out of CoreShop and to avoid common pitfalls. | ||
|
||
## Server Side Rendering | ||
If you do PHP Server Side Rendering with Twig, you should enable the Frontend Bundle in bundles.php: | ||
|
||
```php | ||
// config/bundles.php | ||
return [ | ||
// ... | ||
CoreShop\Bundle\FrontendBundle\CoreShopFrontendBundle::class => ['all' => true], | ||
]; | ||
``` | ||
|
||
### Templates | ||
Symfony allows to override Bundle templates by placing them in the `templates` directory. This is something we don't recommend! | ||
We, at CoreShop, sometimes change Templates, add templates, or rename them. Sometimes on accident, sometimes on purpose. | ||
|
||
To not run into any issues with CoreShop Demo Files to be loaded, we recommend to copy the Templates from the Demo Frontend. | ||
There is also a new command for that: | ||
|
||
```bash | ||
php bin/console coreshop:frontend:install | ||
``` | ||
|
||
This will copy all the templates from CoreShop into `coreshop` and it also replaces all the Bundle Prefixes. That way, you | ||
can be sure that you are using the correct templates. | ||
|
||
This command also creates a configuration to change the `TemplateConfigurator` to use your app template paths and not the | ||
FrontendBundle paths. | ||
|
||
## Headless | ||
If you are going headless, you can simply not enable the Frontend Bundle and do whatever need for your Headless API. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.