Skip to content

Commit 7c5513d

Browse files
docs updated
1 parent 90b2486 commit 7c5513d

9 files changed

+27
-94
lines changed

README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This repository is responsible for Catalog Storefront Application
88
- store data in an efficient way in own database(s)
99

1010
### Service repository Dependencies
11-
- https://github.com/magento/saas-export/ (Provides API to Export entities from Magento to any subscribed consumer)
11+
- https://github.com/magento/commerce-data-export (Provides API to Export entities from Magento to any subscribed consumer)
1212

13-
### 3rd-party dependecnies (composer packages)
13+
### 3rd-party dependencies (composer packages)
1414
- google/protobuf
1515
- grpc/grpc
1616
- spiral/php-grpc
@@ -26,7 +26,7 @@ This project is licensed under the OSL-3.0 License. See [LICENSE](./LICENSE.md)
2626
* [Project Overview:](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/home/Home.md)
2727
* [Scopes (Milestones)](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/home/Milestones.md)
2828
* [Onboarding:](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/onboarding/Project-Onboarding.md)
29-
* [Repositories](https://github.com/magento/storefront-cloud-project/blob/develop/production/.magento.env.yaml)
29+
* [Repositories](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/onboarding/Repositories.md)
3030
* [Services Responsibilities](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/onboarding/Services-responsibilities.md)
3131
* [Time Off Tracking List](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/onboarding/Time-Off-Tracking.md)
3232
* Development:
@@ -42,14 +42,13 @@ This project is licensed under the OSL-3.0 License. See [LICENSE](./LICENSE.md)
4242
* [Catalog Storefront Service Overview](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/designDocuments/Catalog-Storefront-Service.md)
4343
* [Plan to Introduce Back Office APIs](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/designDocuments/Plan-to-introduce-back-office-APIs.md)
4444
* [Product Variants and Type Specific Options](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/designDocuments/Product-variants-and-type-specific-options.md)
45-
* [Catalog Media Tech Vision](https://github.com/magento/architecture/blob/develop/master/design-documents/media/catalog-images.md)
46-
* [Configuration Propagation](https://github.com/magento/architecture/blob/develop/master/design-documents/storefront/configuraiton-propagation.md)
45+
* [Catalog Media Tech Vision](https://github.com/magento/architecture/blob/master/design-documents/media/catalog-images.md)
46+
* [Configuration Propagation](https://github.com/magento/architecture/blob/master/design-documents/storefront/configuraiton-propagation.md)
4747
* [Configurable Product Variants](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/designDocuments/Configurable-products-option-variants.md)
4848
* [Product Variants Services](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/designDocuments/Product-Variants-services.md)
4949
* QA:
5050
* [Storefront Testing](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/qa/Storefront-Testing.md)
5151
* Demo:
5252
* [How To Demo "Add Product with Options to Cart"](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/demo/How-To-Demo-"Add-Product-with-Options-to-Cart".md)
5353
* Contacts:
54-
* [Slack](https://magentocommeng.slack.com/archives/G0157R0PF3J)
55-
54+
* [Slack](https://magentocommeng.slack.com/archives/G0157R0PF3J)

dev/docs/contribution/How-To-Contribute-To-Project.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@ Two main points that is underlie the following instruction:
22
1) magento org is a read-only replica of new primary fork visible only to internal teams
33
2) sync from that invisible primary fork to magento org happens in eventually consistent way
44

5-
The example would be given for complex task that has a code changes for catalog-storefront and saas-export repos but whatever repo of Storefront project you need to contribute the flow will look same.
5+
The example would be given for complex task that has a code changes for catalog-storefront and commerce-data-export repos but whatever repo of Storefront project you need to contribute the flow will look same.
66

77
## Step #1
8-
Make a fork of catalog-storefront and saas-export repos from magento org to your own organisation.
8+
Make a fork of catalog-storefront and commerce-data-export repos from magento org to your own organisation.
99
## Step #2 [optional]
1010
If you are working together with someone else in a team, please create your story-branch from magento/catalog-storefront/develop branch and push it to your fork.
1111
For example, you need auto-generated files from proto-scheme, then someone from internal magento team would be able to create a PR to your story-branch.
1212
## Step #3
13-
When you ready, create a PR from your fork to magento/catalog-storefront and magento/saas-export repos
13+
When you ready, create a PR from your fork to magento/catalog-storefront and magento/commerce-data-export repos
1414

1515
*Note:* don't forget to link the PRs by providing this information under the _Related Pull Requests_ section
1616
*Examples:*
1717
```
1818
### Related Pull Requests
19-
https://github.com/magento/saas-export/pull/9999999
19+
https://github.com/magento/commerce-data-export/pull/9999999
2020
<!-- related pull request placeholder -->
2121
```
2222
## Step #4

dev/docs/designDocuments/Configurable-products-option-variants.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ System has 3 simple products which reflects 3 combinations of those options (blu
2424
2. simple "Red XL" {id: 2, storeViewId: ["default", "storeview2"], color: "red", size: "xl"}
2525
3. simple "Red L" {id: 3, storeViewId: ["default", "storeview2"], color: "red", size: "l"}
2626

27-
## Saas-export part
27+
## Commerce Data Export
2828
in `et_schema.xml` there's the following structure for ProductVariant:
2929
```
3030
<record name="ProductVariant">

dev/docs/home/Home.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The next data should be exposed in Magento:
7272
* Category system attributes.
7373
* Product attributes metadata.
7474

75-
[Optional] By introducing extractor API for Magento we have enough control to deduplicate messages even before they were emitted. And do not emit messages if Magento did not really change the data. (Example1: the product has been saved but no properties were changed, such an event should be ignored; Example 2: Magento should not issue a new event if the product changed inventory records only.). This option is available for the Magento data exporter only. See implementation example https://github.com/magento/saas-export/
75+
[Optional] By introducing extractor API for Magento we have enough control to deduplicate messages even before they were emitted. And do not emit messages if Magento did not really change the data. (Example1: the product has been saved but no properties were changed, such an event should be ignored; Example 2: Magento should not issue a new event if the product changed inventory records only.). This option is available for the Magento data exporter only. See implementation example https://github.com/magento/commerce-data-export
7676

7777
In the general case, the messages filtration should happen at the import step.
7878

dev/docs/home/Milestones.md

-58
This file was deleted.

dev/docs/onboarding/Repositories.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Project Repositories
2+
3+
### Magento Community Edition with Storefront APP
4+
APP | Repo Name | Repo URL | Repo Branch |
5+
| -------- |------------ | ------------- | ------------- |
6+
| Storefront | Catalog Storefront | https://github.com/magento/catalog-storefront | develop
7+
| Storefront | Commerce Data Export | https://github.com/magento/commerce-data-export | main
8+
| Storefront | Storefront Message Broker | https://github.com/magento/storefront-message-broker | main
9+
| | | |
10+
| Magento | Magento CE | https://github.com/magento/magento2 | develop-storefront

dev/docs/onboarding/Services-responsibilities.md

+2-20
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This simplified diagram highlights the main "parts" of Storefront Application (G
2222

2323
## Responsibilities
2424
### Export API.
25-
Source: https://github.com/magento/saas-export/tree/develop-storefront
25+
Source: https://github.com/magento/commerce-data-export/tree/main
2626
**Provide API to Export entities from Magento to any subscribed consumer**
2727
Implement 2 different strategies:
2828
- Push strategy (used by PRex): push changes to remote end-point called Injection Service
@@ -31,7 +31,7 @@ Implement 2 different strategies:
3131
By fact contract of Export API is described in et_schema.xml
3232

3333
### Message Broker.
34-
Source: https://github.com/magento/catalog-storefront/tree/develop/app/code/Magento/CatalogMessageBroker
34+
Source: https://github.com/magento/storefront-message-broker
3535
**Connect Backoffice and Storefront application.**
3636

3737
Responsibilities:
@@ -47,24 +47,6 @@ Responsibilities:
4747
- provide Read API for specific attributes, scope
4848
- store data in an efficient way in own databases
4949

50-
## Modules that will be eliminated (transition period)
51-
52-
### Extension for Backoffice dependent on saas-export repo
53-
Source: [CatalogExport](https://github.com/magento/catalog-storefront/tree/develop/app/code/Magento/CatalogExport), [CatalogExportAPI](https://github.com/magento/catalog-storefront/tree/develop/app/code/Magento/CatalogExportAPI)
54-
Will be eliminated in https://github.com/magento/catalog-storefront/issues/185
55-
56-
57-
58-
### Old Export API
59-
Source: [CatalogExtractor](https://github.com/magento/catalog-storefront/tree/develop/app/code/Magento/CatalogExtractor), any "*Extractor" module
60-
**The previous implementation of Export API. Will be migrated to new Export API**
61-
Will be eliminated after migration all existing Data Providers to Export API
62-
63-
### Connector
64-
Source: https://github.com/magento/catalog-storefront/tree/develop/app/code/Magento/CatalogStorefrontConnector
65-
Responsibilities:
66-
- expose events "storefront.catalog.category.update", "storefront.catalog.product.update" which publish product ids on different events: product saved, category assigned to product, store created...
67-
6850
## Legacy approach (historical notes)
6951

7052
### GQL Extension for Backoffice

dev/docs/projectAgreements/Code-Review-checklist.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Here is a “Code Review checklist" for the Storefront Application project that
1414
- Export API (et_schema.xml) and SF API schemas (proto schema) are reflected in the codebase
1515
- prerequisite: story branch created with all needed generated classes according to proposes schema-changes
1616
- DTO classes does not contain any manual changes (Magento\CatalogExportApi\*, Magento\CatalogStorefrontApi\*)
17-
- Class usage: magento/catalog-storefront repo don't use directly classes from magento/saas-export repo and vise-verse
17+
- Class usage: magento/catalog-storefront repo don't use directly classes from magento/commerce-data-export repo and vise-verse
1818
- Check composer.json dependencies
1919
- note: Can be automated by static test
2020
- Legacy code is deleted
2121
- Any Data Providers present in Connector part (Magento\CatalogStorefrontConnector, Magento\*Extractor modules)
22-
- And Data Providers from Export API (magento/saas-export repo) that is not relevant anymore
22+
- And Data Providers from Export API (magento/commerce-data-export repo) that is not relevant anymore
2323
- Any DTO for Export API/SF API which does not reflect current schema: et_schema, proto schema
2424
- Any “mapper” on Message Broker (between Export API and SF API)
2525
- if mapper still needed, verify fields used in mapping, remove not relevant fields

dev/docs/qa/Storefront-Testing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To run tests for the Storefront Application project we use [GitHub App](https://
44

55
#### Flow:
66
- add a comment in PR, e.g. `@magento run all tests` (see [full list](https://github.com/magento/catalog-storefront/blob/develop/dev/docs/development/Running-tests-on-PR.md))
7-
- Currently, it's configured only for next repos: https://github.com/magento/catalog-storefront, https://github.com/magento/saas-export
7+
- Currently, it's configured only for next repos: https://github.com/magento/catalog-storefront, https://github.com/magento/commerce-data-export
88
GitHub App will ask “Magento Test API” to run tests in PR with [configuration](https://github.com/magento-commerce/engcom-githubapp-pr-mts-builds/blob/master/app/repo-config.js#L652) for SF project
99
- Test results will be provided in PR
1010

0 commit comments

Comments
 (0)