[shopsys] docs: added introduction/faq.md with frequently asked questions #553
Conversation
Miroslav-Stopka
commented
Oct 29, 2018
•
Miroslav-Stopka
commented
| Q | A |
|---|---|
| Description, reason for the PR | Missing FAQ section |
| New feature | No |
| BC breaks | No |
| Fixes issues | #452 |
| Standards and tests pass | Yes |
| Have you read and signed our License Agreement for contributions? | Yes |
Miroslav-Stopka
force-pushed
the
msa-docs-faq-i452
branch
from
ac831fa
to
7b90462
Compare
Miroslav-Stopka
changed the title
|
Hi @TomasLudvik, I cant respond to your comments :/ So Im responding into separated comments |
|
Because the original sentence does not make sense "Changes and language settings" what changes are you talking about?
|
|
Because it is more in line with other titles. I would take this reason when writing standard documentation. But, there are different rules for FAQ section, see for example https://symfony.com/doc/current/frontend/encore/faq.html. Our FAQ section is already different from the standard because, for example, we are describing the visibility much in detail. So the result is, I will not unify the titles |
|
You were saying that in "czech version" so I used that here.
|
|
Because I do not find the connection to the database here necessary in any way. You are describing products here and suddenly referring to the database.
|
|
https://www.macmillandictionary.com/dictionary/british/at-the-same-time
|
| We recommend installation using the Docker for production. | ||
| See how to install Shopsys Framework in production and how to proceed when deploying in the tutorial [Installation Using Docker on Production Server](../installation/installation-using-docker-on-production-server.md). | ||
|
|
||
| ## How to set up the administration with a Czech locale? |
There was a problem hiding this comment.
| ## How to set up the administration with a Czech locale? | |
| ## How to set up the administration with a different locale/language (e.g. Czech)? |
| If you want to switch it to the another locale, override the method `getAdminLocale()` of the class `Shopsys\FrameworkBundle\Model\Localization\Localization`. | ||
| This scenario is described in more detail in the tutorial [How to Set Up Domains and Locales (Languages)](./how-to-set-up-domains-and-locales.md#36-locale-in-administration). | ||
|
|
||
| ## What are the differences between "listable", "sellable", "offered" and "visible" products? |
There was a problem hiding this comment.
This answer is too long. FAQ should contain answers and not documentations. I recommend to move description to separate page of documentation and then put here only one or two sentences + link to docs.
| Sellable products are products that can actually be purchased. | ||
| Only the standard products or the specific variants can actually be purchased. | ||
|
|
||
| ## How calculated attributes work? |
There was a problem hiding this comment.
This answer is too long. FAQ should contain answers and not documentations. I recommend to move description to separate page of documentation and then put here only one or two sentences + link to docs
| It means that the product does not have recalculated availability immediately after the method `edit` is completed. | ||
| This approach with `kernel.response` event is a legacy feature and it will be removed in the future, see [Recalculating products availability and prices immediately instead of on finish request](https://github.com/shopsys/shopsys/issues/202). | ||
|
|
||
| ## How do I change the environment? |
There was a problem hiding this comment.
What is environment? You mean production vs development or you talk about testing environment?
| If the command `composer install --no-dev` is executed, the file `PRODUCTION` is created. | ||
| You can change the environment manually by using the command `php bin/console shopsys:environment:change`. | ||
|
|
||
| ## Is a cron configuration also part of the Shopsys Framework? |
There was a problem hiding this comment.
I would suggest to rephrase question to something like "How should I run periodicly some tasks" or something like this...
| ## Is the application https ready or does it need some extra setting? | ||
| Shopys Framework is fully prepared for HTTPS. | ||
|
|
||
| ## What about translations and language constants export and import? |
There was a problem hiding this comment.
| ## What about translations and language constants export and import? | |
| ## How can I easily translate and set up my new language constants? |
| Modifications are detected via git by comparison against the origin/master version. | ||
|
|
||
| ## Is the application https ready or does it need some extra setting? | ||
| Shopys Framework is fully prepared for HTTPS. |
There was a problem hiding this comment.
So it runs on HTTPS when I install it? I belive not - there is need to get some certificates etc. There should be at least info that instuctions for running HTTPS in prod venvironment are in install guide
There was a problem hiding this comment.
Only SSL certificate is neeeded
| Demo data are used for automatic tests and also for installation of demo shop with prepared data. | ||
| Do not forget to extend the demo data when implementing some new features. | ||
|
|
||
| ## How to perform a change of domain URL? |
There was a problem hiding this comment.
| ## How to perform a change of domain URL? | |
| ## How to change of domain URL? |
| In the second step, you need to replace all occurrences of the old url address in the database with the new url address. | ||
| This scenario is described in more detail in the tutorial [How to Set Up Domains and Locales (Languages)](./how-to-set-up-domains-and-locales.md#4-change-the-url-address-for-an-existing-domain). | ||
|
|
||
| ## How to use migrations and why the developers should use shopsys:migrations:generate instead of the default Doctrine one? |
There was a problem hiding this comment.
| ## How to use migrations and why the developers should use shopsys:migrations:generate instead of the default Doctrine one? | |
| ## How to use database migrations and why the developers should use shopsys:migrations:generate instead of the default Doctrine one? |
| Compared to the standard migrations generation process from Doctrine, this phing target does not generate "irreversible" migrations, such as migrations with the operations `DROP` and `DELETE`. | ||
| Migrations are described more in detail in the docs [Database Migrations](./database-migrations.md) | ||
|
|
||
| ## What are the diff versions of coding standards check commands and what are their limits? |
There was a problem hiding this comment.
Is that a question what are diff versions? Or they do not know that there are any diff version of CS? What about to change question to "What are options of CS?" or something like this?
There was a problem hiding this comment.
Je nutno spoustet standardy nad vsemi soubory?
Miroslav-Stopka
force-pushed
the
msa-docs-faq-i452
branch
from
e40077b
to
34d3ef3
Compare
README.md
Outdated
| @@ -76,6 +76,8 @@ For more detailed instructions, follow one of the installation guides: | |||
| ## Documentation | |||
| For documentation of Shopsys Framework itself, see [Shopsys Framework Knowledge Base](./docs/index.md). | |||
|
|
|||
| For the frequently asked questions, see [FAQ and Common Issues](./introduction/faq-and-common-issues.md). | |||
| For the installation of the multidomain demo data, use the phing target `db-fixtures-demo-multidomain`. | ||
| These phing targets are also triggered as the part of others phing targets, see `build.xml` and `build-dev.xml`. | ||
| Demo data are used for automatic tests and also for installation of demo shop with prepared data. | ||
| Do not forget to extend the demo data when implementing some new features. |
There was a problem hiding this comment.
How can I do it? Can you provide a link that helps me with data fixtures extension?
|
|
||
| ## How to change a domain URL? | ||
| The change of domain url requires two steps. | ||
| In the first step, you need to modify the domain url in the configuration file `app/config/domains.yml`. |
There was a problem hiding this comment.
This is maybe just my knowledge lack of shopsys framework. But I thought that I have to modify domains_urls.yml, because there are urls. I don't know what to modify in domains.yml when I want to have my shop on http://10.0.0.1
| ## What are the data fixtures good for? | ||
| Data fixtures are actually demo data available in the Shopys Framework. | ||
| There are two kinds of demo data, the singledomain and the multidomain. | ||
| For the installation of the basic demo data, use the phing target `db-fixtures-demo-singledomain`. |
There was a problem hiding this comment.
I tried to run php phing db-fixtures-demo-singledomain and it gives me errors.
I think I'm not supposed to run db-fixtures-demo-* targets manually but by db-demo
| You can change the environment manually by using the command `php bin/console shopsys:environment:change`. | ||
|
|
||
| ## Are some periodic tasks part of the Shopsys Framework (cron)? | ||
| Yes, there is some prepared configuration for Shopsys Framework cron commands in a file `shopsys/packages/framework/src/Resources/config/services/cron.yml`. |
There was a problem hiding this comment.
the whole FAQ is written from point of view of project-base. But here you are navigating user from monorepo. I suggest to remove the path and leave "in a shopsys framework cron.yml" only
|
|
||
| ## How to change a domain URL? | ||
| The change of domain url requires two steps. | ||
| In the first step, you need to modify the domain url in the configuration file `app/config/domains_urls.yml`. |
There was a problem hiding this comment.
It is out of the scope of this US, but domain.yml is also in https://github.com/shopsys/shopsys/blob/master/docs/introduction/how-to-set-up-domains-and-locales.md#4-change-the-url-address-for-an-existing-domain
Please correct it also there OR create an issue that would fix it
| ## What are the data fixtures good for? | ||
| Data fixtures are actually demo data available in the Shopys Framework. | ||
| There are two kinds of demo data, the singledomain and the multidomain. | ||
| For the installation of the basic demo data, you need to have just one domain configured, use the phing target `db-fixtures-demo-singledomain`. |
There was a problem hiding this comment.
First - this changed sentence is not right. If I have 2 domains, I have to run db-fixtures-demo-singledomain too (and then db-fixtures-demo-multidomain)
And again - if I just run these targets, I end up with an error, because these targets expect the system in a certain state.
I recommend to leave here just db-demo as it works in any condition - first it wipes public scheme.
in domains_urls.yml instead of domains.yml
Miroslav-Stopka
force-pushed
the
msa-docs-faq-i452
branch
from
3b07b54
to
5a4e0d7
Compare
