spryker/spryker-docs

This repository is for the Spryker documentation available at https://docs.spryker.com.

Spryker documentation

This repository contains the documentation for the Spryker documentation portal.

Installation

To build the documentation site locally, see building the documentation site.

Build with Docker

To build the documentation site with Docker, run this command: docker run --rm --volume="$PWD:/srv/jekyll" --volume="$PWD/vendor/bundle:/usr/local/bundle" -p 4000:4000 jekyll/jekyll:4.2.0 jekyll serve --incremental --livereload

Contribute

For the specific Markdown syntax we use in documentation, see Markdown syntax. For the general style, syntax, and formatting rules, see Style, syntax, formatting, and general rules.

To suggest changes, follow the steps:

1. Fork the repository.
2. In your forked repository, go to the document you want to edit. The actual documents are in the docs/ directory.
3. To edit the document, click the pencil icon in the top right menu.
4. Add the needed changes.
5. In the Commit changes pane, describe your changes and click Commit changes. This shows the updated document.
6. To go to the main page of the repository, click Code.
7. Next to This branch is 1 commit ahead of spryker:master., click Contribute > Open pull request.
8. Enter a Title.
9. For Write, enter a description of your changes.
10. Click Create pull request.
11. To confirm that the PR is ready to merge, set a label, like in progress, tech review needed, or TW review needed.

That’s it! Your pull request has been created. Once we review and approve the changes, they will be published on the documentation website.

Contributors

Thank you to all our contributors!

spryker-docs's Issues

Fix wrong API term on two pages

These two pages use "Backend API" when it actually should say "Zed API" because they are still using the old API. Only modules that use the new backend API should use "Backend API" in the documentation.

• https://docs.spryker.com/docs/scos/dev/feature-integration-guides/202204.0/backend-api-for-merchant-relationships-integration-guide.html
• https://docs.spryker.com/docs/scos/dev/feature-integration-guides/202204.0/backend-api-for-merchant-relationships-integration-guide.html

Missing CMS page navigation and broken links

The bottom of this page: https://docs.spryker.com/docs/scos/user/features/202204.0/cms-feature-overview/cms-feature-overview.html#cms-glossary
Has a number of links that are incorrect and link to checkout sections.

On further inspection, within the sidebar navigation there are a number of missing links that show as broken in the nav. I believe these are the pages that the above should be linking to.

Search feature overview has incorrect statement about Search functionality

Product reviews are really indexed, but they are not used in product searches. Only aggregated rating is used for filtering and sorting products in the catalog.

Loading 'Install the Multiple Carts feature' page results in endless redirect

Loading the 202212.0 version of the 'Install the Multiple Carts feature' page results in endless redirect:
https://docs.spryker.com/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html

Environment Variable Documentation

We noticed there are ~160 environment variables defined for a spryker project.
May i ask you to provide a documentation in form of a table?

Here some examples:

Environment Variables

1. 'SPRYKER_LOG_STDERR'
2. 'SPRYKER_LOG_STDOUT'
3. 'SPRYKER_BE_HOST'
4. 'SPRYKER_FE_HOST'
5. 'DEVELOPMENT_CONSOLE_COMMANDS'
6. 'SPRYKER_TRUSTED_HOSTS'
7. 'SPRYKER_ZED_REQUEST_TOKEN'
8. 'SPRYKER_OAUTH_KEY_PRIVATE'
9. 'SPRYKER_OAUTH_KEY_PUBLIC'
10. 'SPRYKER_OAUTH_ENCRYPTION_KEY'
11. 'SPRYKER_OAUTH_CLIENT_IDENTIFIER'
12. 'SPRYKER_OAUTH_CLIENT_SECRET'
13. 'SPRYKER_OAUTH_CLIENT_CONFIGURATION'
14. 'SPRYKER_ZED_REQUEST_TOKEN'
15. 'SPRYKER_DB_ENGINE'
16. 'SPRYKER_DB_HOST'
17. 'SPRYKER_DB_PORT'
18. 'SPRYKER_DB_USERNAME'
19. 'SPRYKER_DB_PASSWORD'
20. 'SPRYKER_DB_DATABASE'
21. 'SPRYKER_DB_REPLICAS'
22. 'SPRYKER_SEARCH_HOST'
23. 'SPRYKER_SEARCH_PROTOCOL'
24. 'SPRYKER_SEARCH_PORT'
25. 'SPRYKER_SEARCH_BASIC_AUTH'
26. 'SPRYKER_SEARCH_INDEX_PREFIX'
27. 'SPRYKER_KEY_VALUE_STORE_ENGINE'
28. 'SPRYKER_KEY_VALUE_STORE_PROTOCOL'
29. 'SPRYKER_KEY_VALUE_STORE_HOST'
30. 'SPRYKER_KEY_VALUE_STORE_PORT'
31. 'SPRYKER_KEY_VALUE_STORE_PASSWORD'
32. 'SPRYKER_KEY_VALUE_STORE_NAMESPACE'
33. 'SPRYKER_KEY_VALUE_STORE_SOURCE_NAMES'
34. 'SPRYKER_KEY_VALUE_STORE_CONNECTION_OPTIONS'
35. 'SPRYKER_SESSION_FE_PROTOCOL'
36. 'SPRYKER_SESSION_FE_HOST'
37. 'SPRYKER_SESSION_FE_PORT'
38. 'SPRYKER_SESSION_FE_PASSWORD'
39. 'SPRYKER_SESSION_FE_NAMESPACE'
40. 'SPRYKER_SESSION_BE_PROTOCOL'
41. 'SPRYKER_SESSION_BE_PORT'
42. 'SPRYKER_SESSION_BE_PASSWORD'
43. 'SPRYKER_SESSION_BE_NAMESPACE'
44. 'SPRYKER_ZED_SESSION_COOKIE_SAMESITE'
45. 'SPRYKER_LOG_STDERR'
46. 'SPRYKER_BROKER_API_HOST'
47. 'SPRYKER_BROKER_API_PORT'
48. 'SPRYKER_BROKER_API_USERNAME'
49. 'SPRYKER_BROKER_API_PASSWORD'
50. 'SPRYKER_BROKER_NAMESPACE'
51. 109. 'SPRYKER_BROKER_PASSWORD'
52. 'SPRYKER_BROKER_USERNAME'
53. 'SPRYKER_BROKER_HOST'
54. 'SPRYKER_BROKER_PORT'
55. 'SPRYKER_BROKER_PASSWORD'
56. 'SPRYKER_BROKER_USERNAME'
57. 'SPRYKER_BROKER_CONNECTIONS'
58. 'SPRYKER_JENKINS_CSRF_PROTECTION_ENABLED'
59. 'SPRYKER_SCHEDULER_PROTOCOL'
60. 'SPRYKER_SCHEDULER_HOST'
61. 'SPRYKER_SCHEDULER_PORT'
62. 'SPRYKER_JENKINS_TEMPLATE_PATH'
63. 'SPRYKER_SMTP_HOST'
64. 'SPRYKER_SMTP_PORT'
65. 'SPRYKER_SMTP_ENCRYPTION'
66. 'SPRYKER_SMTP_AUTH_MODE'
67. 'SPRYKER_SMTP_USERNAME'
68. 'SPRYKER_SMTP_PASSWORD'
69. 'SPRYKER_MAIL_SENDER_EMAIL'
70. 'SPRYKER_MAIL_SENDER_NAME'
71. 'SPRYKER_ZED_SSL_ENABLED'
72. 'SPRYKER_ZED_PORT'
73. 'SPRYKER_ZED_HOST'
74. 'SPRYKER_FE_PORT'
75. 'SPRYKER_GLUE_APPLICATION_CORS_ALLOW_ORIGIN'
76. 'SPRYKER_GLUE_BACKEND_HOST'
77. 'SPRYKER_GLUE_STOREFRONT_HOST'
78. 'SPRYKER_DEBUG_ENABLED'
79. 'SPRYKER_DEBUG_PROPEL_ENABLED'
80. 'SPRYKER_TESTING_ENABLED'
81. 'DEVELOPMENT_CONSOLE_COMMANDS'
82. 'SPRYKER_DEBUG_DEPRECATIONS_ENABLED'
83. 'SPRYKER_BROKER_HOST'
84. 'SPRYKER_BROKER_PORT'
85. 'SPRYKER_BROKER_PASSWORD'
86. 'SPRYKER_BROKER_USERNAME'
87. 'SPRYKER_SSL_ENABLE'
88. 'SPRYKER_BE_HOST'
89. 'SPRYKER_API_HOST'
90. 'SPRYKER_API_PORT'
91. 'APPLICATION_ENV'

After Performing Step Getting error

[zed-backoffice] [backoffice_us] - [2022-08-28T06:56:02.464722+00:00] defaultLogger.ERROR: SQLSTATE[42S22]: Column not found: 1054 Unknown column 'spy_customer.description' in 'field list' [] []

Add temporary Apple M1 docker fix

On this page:
https://github.com/spryker/spryker-docs/blob/master/docs/scos/dev/setup/installing-spryker-with-docker/installation-guides/installing-in-development-mode-on-macos-and-linux.md

Please add this alternative for those who have Apple M1 chips:

git clone https://github.com/spryker/docker-sdk.git --branch apple-m1-adjustments --single-branch docker

github: link error

The link in the github description is wrong:

https://docs.spryker.com./

Inconsistent examples for Glue Resource Plugin implementation

On the page
https://docs.spryker.com/docs/scos/dev/glue-api-guides/202204.0/decoupled-glue-infrastructure/how-to-guides/routing/how-to-create-a-storefront-resource.html
it shows how to implement \Pyz\Glue\ModuleRestApi\Plugin\JsonConventionModuleResource

There are 2 problems with that:

1. It implements JsonApiResourceInterface which is not present in any use section and doesn't exist in the codebase at all
2. It conflicts with the approach that is used in the https://docs.spryker.com/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/implement-a-rest-api-resource.html#route-requests-to-your-controller for WishlistsResourceRoutePlugin

By the way the approach from second points implements \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRoutePluginInterface so it's not clear what should I use.

Thanks

Tutorial Checkout

Guys i get this error...
From this Tutorial

YVES Exception
ErrorException - FATAL ERROR - Access level to Pyz\Yves\CheckoutPage\Plugin\Router\CheckoutPageRouteProviderPlugin::CHECKOUT_VOUCHER must be public (as in class SprykerShop\Yves\CheckoutPage\Plugin\Router\CheckoutPageRouteProviderPlugin)
in /data/src/Pyz/Yves/CheckoutPage/Plugin/Router/CheckoutPageRouteProviderPlugin.php (7)

Url:/en/checkout/address

Trace:

#0 /data/vendor/spryker/error-handler/src/Spryker/Shared/ErrorHandler/ErrorHandlerEnvironment.php(107): Spryker\Shared\ErrorHandler\ErrorHandler->handleFatal()
#1 [internal function]: Spryker\Shared\ErrorHandler\ErrorHandlerEnvironment->Spryker\Shared\ErrorHandler\{closure}()
#2 {main}

after i change die CONST to public i get this...

ErrorException - FATAL ERROR - Could not check compatibility between Pyz\Yves\CheckoutPage\Plugin\Router\CheckoutPageRouteProviderPlugin::addRoutes(Pyz\Yves\CheckoutPage\Plugin\Router\RouteCollection $routeCollection): Pyz\Yves\CheckoutPage\Plugin\Router\RouteCollection and SprykerShop\Yves\CheckoutPage\Plugin\Router\CheckoutPageRouteProviderPlugin::addRoutes(Spryker\Yves\Router\Route\RouteCollection $routeCollection): Spryker\Yves\Router\Route\RouteCollection, because class Pyz\Yves\CheckoutPage\Plugin\Router\RouteCollection is not available
in /data/src/Pyz/Yves/CheckoutPage/Plugin/Router/CheckoutPageRouteProviderPlugin.php (21)

Url:/en/checkout/address

Trace:

#0 /data/vendor/spryker/error-handler/src/Spryker/Shared/ErrorHandler/ErrorHandlerEnvironment.php(107): Spryker\Shared\ErrorHandler\ErrorHandler->handleFatal()
#1 [internal function]: Spryker\Shared\ErrorHandler\ErrorHandlerEnvironment->Spryker\Shared\ErrorHandler\{closure}()
#2 {main}

i fix this with use Spryker\Yves\Router\Route\RouteCollection;
after i get this

An exception has been thrown during the rendering of a template ("None of the chained routers were able to generate route: Route 'checkout-test' not found, Route 'Route 'checkout-test' not found' not found").

Guys u need to Update your Docs 👍

Need to update the text in the diagram

Inside "How translation are merged" topic, the diagram text should be replaced.

Text should be:
"Data processed with Publish&Synchronize"
instead of:
"data synched with Publish&Synchronize"

https://docs.spryker.com/docs/scos/dev/feature-walkthroughs/202212.0/spryker-core-feature-walkthrough/how-translations-are-managed.html

Incorrect feature version on 'Install the Multiple Carts feature' page

The 202307.0 and 202311.0 version of the 'Install the Multiple Carts feature' page lists 202307.0 and 202311.0 versions of Persistent Cart feature as prerequisite for the Multiple Carts feature. However, latest version of the Persistent Cart feature is 202009.0

Image in Bundle Docs

https://docs.spryker.com/docs/scos/user/features/202108.0/product-bundles-feature-overview.html#product-bundle-entity-relationship-diagram

inside diagram the top left box has to be table "spy_product" + "id_product". Its a big difference, because we can only bundle concrete products not abstract.

File resolver updates are missing from S3 Import documentation

If the file you're trying to import from the S3 Bucket doesn't exist in the local folder the import process will throw an error. This is due to a validation vendor/spryker/data-import/src/Spryker/Zed/DataImport/Business/Model/DataReader/FileResolver/FileResolver.php:63 that checks if the file exists in the file system.

The FileResolver.php file also needs to be overridden and replaced with a function to check whether the file exists in the S3 Bucket or not.

Include an alternative download link for Docker (Apple Chip - ARM64)

See point 1 here.

Double PHP Opening Tags

spryker-docs/docs/scos/dev/glue-api-guides/202311.0/create-json-api-relationships.md

Line 27 in a68e918

<?php

RFQ - Quote Request APIs' public documents is missing

Repo:
https://github.com/spryker/quote-request-agents-rest-api
https://github.com/spryker/quote-requests-rest-api

Note: I think both APIs are in Beta version so not sure if we can do this ..

Wrong hosts entry for Backoffice and missing credentials

Dear,
using docker-sdk in Linux it automatically give the entries to be added in /etc/hosts:

sudo bash -c "echo '127.0.0.1 backend-api.at.spryker.local backend-api.de.spryker.local backend-api.us.spryker.local backend-gateway.at.spryker.local backend-gateway.de.spryker.local backend-gateway.us.spryker.local backoffice.at.spryker.local backoffice.de.spryker.local backoffice.us.spryker.local glue.at.spryker.local glue.de.spryker.local glue.us.spryker.local mail.spryker.local queue.spryker.local scheduler.spryker.local spryker.local swagger.spryker.local yves.at.spryker.local yves.de.spryker.local yves.us.spryker.local' >> /etc/hosts

It is different of what written in doc and miss the zed.* entries.
The same problem with Endpoint table.
I don't know which is the correct endpoints, if it is a doc mistake or sdk error.
On the same doc page there is no indication on how to get the credential for acceding Backoffice endpoint (found in src/Pyz/Zed/User/UserConfig.php).
Thanks.
Ivan