New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sylius cloud cookbook #16091
base: 1.12
Are you sure you want to change the base?
Sylius cloud cookbook #16091
Conversation
senghe
commented
Apr 3, 2024
Q | A |
---|---|
Branch? | 1.12 |
Bug fix? | no |
New feature? | no |
BC breaks? | no |
Deprecations? | no |
Related tickets | - |
License | MIT |
Bunnyshell Preview Environment deployedIt will be automatically stopped in 4 hours. Use the command
Available commands:
|
|
||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for the lines 8-10 but it didn't catch it somehow 🤷🏽
First step you need to do is to create a Sylius Cloud project. To do it, please log in to your Sylius Cloud account and click "Create a new project" button from the dashboard. | ||
You can also do it by running the CLI command: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case I think we should mention that we need to log in to Platform.sh account, as it could be misleading a bit 🤔
First step you need to do is to create a Sylius Cloud project. To do it, please log in to your Sylius Cloud account and click "Create a new project" button from the dashboard. | |
You can also do it by running the CLI command: | |
First step you need to do is to create a Sylius Cloud project. To do it, please log in to your Platform.sh account or create a new one if you have not any and click "Create a new project" button from the dashboard. | |
You can also do it by running the CLI command: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would also mention creating the organisation, as without it it's impossible to create a project
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And add some screenshots, simplyfing the first steps
| | ||
|
||
When you've created the project, you're ready to create new environments. Please note that your project already have the first (production) environment just after project is being created. | ||
Regarding of creating new environment, we assume you're a developer, so it will be more convenient for you to use the CLI command: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regarding of creating new environment, we assume you're a developer, so it will be more convenient for you to use the CLI command: | |
Regarding of creating new environment, you can do it by creating it on the cloud management site or by the following the command: |
|
||
| | ||
|
||
When you've created the project, you're ready to create new environments. Please note that your project already have the first (production) environment just after project is being created. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if We would like to emphasize further that environments are essentially open branches that could be used in the name of testing, development, new features like you said in the line 89
Creating a new project and environment | ||
-------------------------------------- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to be doubled with docs/cookbook/sylius-cloud/basic-project-setup.rst
, but there is more about CI solution, I'm more into putting the all steps, UI or CI within one section if it's related to one thing
|
||
platform db:sql "show tables" | ||
|
||
If you with to import an SQL file into the database, you can run the command below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you with to import an SQL file into the database, you can run the command below: | |
If you wish to import an SQL file into the database, you can run the command below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My overall thoughts:
- The prepared configuration works well for both
Sylius 1.12
andSylius 1.13
. - Our current documentation includes the page about the
Platform.sh
deployment guide. However, since we have integrated the initial configuration into the codebase, the aforementioned page is now obsolete and should be deleted. - The extensive documentation on platform management appears to be in good shape. However, in my opinion, it might be beneficial to prevent potential users from feeling overwhelmed. I suggest initially presenting only the essential steps required to deploy the app, as in my case:
- creating a
Platform.sh
account - creating the project (including setting up the organization)
- running the
symfony cloud:push
command (installing theplatform
command was not even necessary).
This could have encouraged further development as the app is already live and the user is happy.
Afterward, we can introduce additional possibilities.
|
||
To enable preloading, please: | ||
|
||
1. Ensure that your Symfony application is using PHP version 7.4 or higher, as preloading is supported in these versions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Ensure that your Symfony application is using PHP version 7.4 or higher, as preloading is supported in these versions. | |
1. Ensure that your Symfony application is using PHP version 8.3 or higher, as preloading is supported in these versions. |