From 46ab4b87de7975297d1b8e89a3c7e4987e1cb63c Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Wed, 31 May 2023 17:04:53 +0200 Subject: [PATCH 1/3] Doc release notes May 2023 --- _data/sidebars/scos_dev_sidebar.yml | 2 +- ...additional-logic-in-dependency-provider.md | 8 +--- .../dead-code-checker.md | 2 +- .../intro-to-spryker/docs-release-notes.md | 37 +++++++++++++++++++ 4 files changed, 41 insertions(+), 8 deletions(-) diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index f0ae58c4793..9b88d3ef7c9 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -5018,7 +5018,7 @@ entries: url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.html - title: Plugin registration with restrictions url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.html - - title: Security + - title: Security checker url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.html - title: Single plugin argument url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.html diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md index 5b870b36b61..5a4c417d603 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md @@ -1,16 +1,12 @@ --- -title: Dependency provider contains addition logic +title: Additional logic in dependency provider description: Reference information for evaluator tools. template: howto-guide-template --- -Additional logic inside the dependency provider’s methods. - -## Problem description - On the project level, developers use `if` constructs with variety of expressions in dependency providers to register the plugins in particular cases only. -Not all possible expressions are needed inside of the `if` statements for plugin registration and not all of them are supported. This check will verify that if an `if` construct is used for plugin registration, then only one of the following expressions is used: +Not all possible expressions are needed inside of the `if` statements for plugin registration and not all of them are supported. This check verifies that if an `if` construct is used for plugin registration, then only one of the following expressions is used: `class_exists` it is allowed for BC reasons diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md index e4a8ec9580e..9c9b1d6ed65 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md @@ -1,5 +1,5 @@ --- -title: A dead code checker +title: Dead code checker description: Reference information for evaluator tools. template: howto-guide-template --- diff --git a/docs/scos/user/intro-to-spryker/docs-release-notes.md b/docs/scos/user/intro-to-spryker/docs-release-notes.md index 8bd5cfa3e5f..48804038139 100644 --- a/docs/scos/user/intro-to-spryker/docs-release-notes.md +++ b/docs/scos/user/intro-to-spryker/docs-release-notes.md @@ -4,6 +4,43 @@ description: Spryker docs release notes template: concept-topic-template --- +## May 2023 + +In May 2023, we have added and updated the following pages: + +### New pages + +- [Docs release notes](/docs/scos/user/intro-to-spryker/docs-release-notes.html) +- Multistore documentation: + - [Multistore setup options](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html): Learn about all the setup options you have for a multistore environment. + - [Checklist for a new store implementation](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/checklist-for-a-new-store-implementation.html): Overview of the high-level tasks and responsibilities of Spryker and Customer when setting up a new store. +- [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html): Learn how to install the App Orchestration Platform. +- [Run the evaluator tool](/docs/scos/dev/guidelines/keeping-a-project-upgradable/run-the-evaluator-tool.html): Learn how to write the evaluator tool. +- [Upgardability guidelines](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.html): + - [Additional logic in dependency provider](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html): Resolve issues with additional logic in dependency provider + - [Dead code checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.html): Check if there is dead code that extends core classes in your project. + - [Minimum allowed shop version](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html): Learn how to resolve issues with project upgradability when your projects contains old package dependencies that are already not supported. + - [Multidimensional array](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.html): Resolve issues with the multidimensional arrays inside the dependency provider’s methods. + - [PHP version](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.html): Make sure the allowed and consistent PHP version is used in different project parts. + - [Plugin registration with restrictions](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.html): Resolve isues related to plugin registration with restrictions. + - [Security checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.html): Check if your PHP application depends on PHP packages with known security vulnerabilities. + - [Single plugin argument](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.html): Resolve issues related to single plugin arguments inside the dependency provider’s methods. +- [HowTo: Allow Zed SCSS/JS on a project level for `oryx-for-zed` version 2.12.0 and earlier](/docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.12.0-and-earlier.html) +- [HowTo: Allow Zed SCSS/JS on a project level for `oryx-for-zed` version 2.13.0 and later](/docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.13.0-and-later.html) +- [Add variables in the Parameter Store](/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html) +- [Change default branch](/docs/scu/dev/change-default-branch.html): Learn how to change the default branch in Spryker CI + +### Updated pages + +- [HowTo: Set up multiple stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html): Learn how to set up multiple stores. +- [App manifest](/docs/acp/user/app-manifest.html): Learn about the app manifest files and what necessary information they must contain +- [Spryker Code Upgrader](/docs/scu/dev/spryker-code-upgrader.html): Learn how to use the Spryker Code Upgrader to update your project easily. +- [Performance testing in staging environments](/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.html): Our tips on executing the performance testing +- [Configuring debugging in Docker](/docs/scos/dev/the-docker-sdk/202212.0/configuring-debugging-in-docker.html): Learn how to configure debugging in Docker. +- [Environment provisioning](/docs/cloud/dev/spryker-cloud-commerce-os/environment-provisioning.html): Learn how you can submit an environment provisioning request. +- [Configure Algolia](/docs/pbc/all/search/202212.0/third-party-integrations/configure-algolia.html): Learn how to configure the Algolia app. +- [Integrate Algolia](/docs/pbc/all/search/202212.0/third-party-integrations/integrate-algolia.html): Learn how to integrate the Algolia app. + ## April 2023 In April 2023, we have added and updated the following pages: From ccc385f816dded430974c7ea70d43b75de507a53 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Wed, 31 May 2023 18:12:15 +0200 Subject: [PATCH 2/3] Updating the release notes --- Rakefile | 1 + .../intro-to-spryker/docs-release-notes.md | 30 +++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/Rakefile b/Rakefile index d0e13fc8a6b..2fe24bf3993 100644 --- a/Rakefile +++ b/Rakefile @@ -53,6 +53,7 @@ commonOptions = { /twitter.com\/[\.\w\-\/\?]+/, /www.optimise-it.de\/[\.\w\-\/\?]+/, /blackfire.io\/[\.\w\-\/\?]+/, + /rxjs.dev/\/[\.\w\-\/\?]+/, /www.blackfire.io\/[\.\w\-\/\?]+/ ], :file_ignore => [], diff --git a/docs/scos/user/intro-to-spryker/docs-release-notes.md b/docs/scos/user/intro-to-spryker/docs-release-notes.md index 48804038139..1cfd14ec788 100644 --- a/docs/scos/user/intro-to-spryker/docs-release-notes.md +++ b/docs/scos/user/intro-to-spryker/docs-release-notes.md @@ -29,6 +29,36 @@ In May 2023, we have added and updated the following pages: - [HowTo: Allow Zed SCSS/JS on a project level for `oryx-for-zed` version 2.13.0 and later](/docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.13.0-and-later.html) - [Add variables in the Parameter Store](/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html) - [Change default branch](/docs/scu/dev/change-default-branch.html): Learn how to change the default branch in Spryker CI +- [Oryx](/docs/scos/dev/front-end-development/202212.0/oryx/oryx.html) documentation: + - [Set up Oryx](/docs/scos/dev/front-end-development/202212.0/oryx/set-up-oryx.html): Learn how to set up an environment for developing in the Oryx framework. + - [Oryx: Boilerplate](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-boilerplate.html): Create maintainable and upgradeable applications using the Oryx boilerplate. + - [Oryx: Feature sets](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-feature-sets.html): Learn what the feature sets in Oryx are all about. + - [Oryx: Packages](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-packages.html): Use Oryx packages from npm to ensure you can easily upgrade to newer versions. + - [Oryx: Routing](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-routing.html): Lear how to set up the Oryx routing. + - [Oryx: Versioning](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-versioning.html): Learn about the methods used in Oryx to deliver an advanced application development platform while maintaining stability. + - [Oryx: Supported browsers](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-supported-browsers.html): Learn what browsers Oryx supports. + - [Dependency injection](/docs/scos/dev/front-end-development/202212.0/oryx/dependency-injection/dependency-injection.html): Learn about the dependency injection that lets you customize logic but keep your project upgradable. + - [Oryx service layer](/docs/scos/dev/front-end-development/202212.0/oryx/dependency-injection/oryx-service-layer.html): Learn about the service layer in Oryx serves as the foundation for the business logic. + - [Dependency Injection: Using services](/docs/scos/dev/front-end-development/202212.0/oryx/dependency-injection/dependency-injection-using-services.html): Learn how to inject services and dependencies. + - [Dependency Injection: Defining services](/docs/scos/dev/front-end-development/202212.0/oryx/dependency-injection/dependency-injection-defining-services.html): Recommended conventions for defining services. + - [Dependency Injection: Providing services](/docs/scos/dev/front-end-development/202212.0/oryx/dependency-injection/dependency-injection-providing-services.html): Recommended conventions for providing services. + - [Dependency Injection: Advanced strategies](/docs/scos/dev/front-end-development/202212.0/oryx/dependency-injection/dependency-injection-advanced-strategies.html): Strategies for using DI that cover advanced use cases. + - [Oryx application orchestration](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-application-orchestration/oryx-application-orchestration.html): Orchestration of the Oryx Application. + - [Oryx application](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-application-orchestration/oryx-application.html): Learn about the app of the Oryx Application. + - [Oryx application environment](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-application-orchestration/oryx-application-environment.html): Learn about the environment of the Oryx Application. + - [Oryx application feature](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-application-orchestration/oryx-application-feature.html): Learn about the feature of the Oryx Application. + - [Oryx application plugins](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-application-orchestration/oryx-application-plugins.html): Learn about plugins of the Oryx Application. + - [Reactivity](/docs/scos/dev/front-end-development/202212.0/oryx/reactivity/reactivity.html): Learn Reactivity enables real-time updates. + - [Key concepts of Reactivity](/docs/scos/dev/front-end-development/202212.0/oryx/reactivity/key-concepts-of-reactivity.html): Understand the Reactivity concepts that will help you understand how Oryx works. + - [Reactive components](/docs/scos/dev/front-end-development/202212.0/oryx/reactivity/reactive-components.html): Learn about the reactive components that are built with Lit. + - [Oryx: Integration of backend APIs](/docs/scos/dev/front-end-development/202212.0/oryx/reactivity/oryx-integration-of-backend-apis.html): Compose a frontend application from backend APIs. + + + + + + + ### Updated pages From e570ec9a48b7ccf742839c01890b2b69feeae0d4 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Wed, 31 May 2023 18:43:17 +0200 Subject: [PATCH 3/3] adjusting the rakefile --- Rakefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index 2fe24bf3993..9f785af5486 100644 --- a/Rakefile +++ b/Rakefile @@ -53,7 +53,7 @@ commonOptions = { /twitter.com\/[\.\w\-\/\?]+/, /www.optimise-it.de\/[\.\w\-\/\?]+/, /blackfire.io\/[\.\w\-\/\?]+/, - /rxjs.dev/\/[\.\w\-\/\?]+/, + /rxjs.dev\/[\.\w\-\/\?]+/, /www.blackfire.io\/[\.\w\-\/\?]+/ ], :file_ignore => [],