Merge pull request #1875 from spryker/keeping-the-project-upgradable

Introducing fixes to upgradability docs

_data/sidebars/scos_dev_sidebar.yml

@@ -5004,7 +5004,7 @@ entries:
     - title: Keeping a project upgradable
       url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html
       nested:
-      - title: Supported extension scenarios
+      - title: Extension scenarios
         nested:
         - title: Event subscribers' registration
           url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/event-subscribers-registration.html

docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/event-subscribers-registration.md → docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/event-subscribers-registration.md

@@ -10,6 +10,9 @@ related:
     link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/plugins-registration.html
   - title: Modules configuration
     link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/modules-configuration.html
+redirect_from: 
+  - /docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/event-subscribers-registration.html
+
 ---
 
 [Manifests](/docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html#follow-the-upgradability-best-practices) support registering event subscribers only in the dependency provider, a type of code class.

docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/extenstion-scenarios.md

@@ -0,0 +1,12 @@
+---
+title: Extension scenarios
+description: Supported extension scenarios for event subscribers registration, modules configuration, plugins registration
+last_updated: May 2513, 2023
+template: concept-topic-template
+---
+
+This section describes the supported extension scenarios for the following entities:
+
+- [Event subscribers registration](/docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/event-subscribers-registration.html)
+- [Modules configuration](/docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/modules-configuration.html)
+- [Plugins registration](/docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/plugins-registration.html)

docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/modules-configuration.md → docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/modules-configuration.md

@@ -10,6 +10,8 @@ related:
     link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/plugins-registration.html
   - title: Event subscribers registration
     link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/event-subscribers-registration.html
+redirect_from:
+    - /docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/modules-configuration.html
 ---
 
 

docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/plugins-registration.md → docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/plugins-registration.md

@@ -10,6 +10,8 @@ related:
     link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/event-subscribers-registration.html
   - title: Modules configuration
     link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/modules-configuration.html
+redirect_from:
+    - /docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/plugins-registration.html
 ---
 
 Manifests support plugins registration in the dependency provider and plugins registration in the configuration files. There are multiple ways how plugins can be registered inside of the project. 

docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.md

@@ -57,4 +57,6 @@ In case of a project that uses a method to change code that is not covered, any
 
 {% endinfo_block %}
 
+## Bypass project upgradability issues
 
+Learn how you can avoid and fix the project [upgradability issues](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.html).

docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md

@@ -4,6 +4,10 @@ description: Reference information for evaluator tools.
 template: howto-guide-template
 ---
 
+This document explains how you can bypass issues with 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 verifies that if an `if` construct is used for plugin registration, then only one of the following expressions is used:

docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md

@@ -4,7 +4,7 @@ description: Reference information for evaluator tools.
 template: howto-guide-template
 ---
 
-This checker checks for dead code that extends core classes in your project.
+The dead code checker checks for dead code that extends core classes in your project.
 
 ## Problem description
 

docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md

@@ -54,4 +54,4 @@ MINIMUM ALLOWED SHOP VERSION
 
 ### Resolving the error
 
-To resolve this issue, you need to update the outdated dependencies to the current release or version.
+To resolve this issue, update the outdated dependencies to the current release or version.

docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md

@@ -4,7 +4,7 @@ description: Reference information for evaluator tools.
 template: howto-guide-template
 ---
 
-This document describes multidimensional arrays inside the dependency provider’s methods, and how to resolve problems related to them.
+This document describes multidimensional arrays inside the dependency provider’s methods, and how to resolve issues related to them.
 
 ## Problem description
 

docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md

@@ -4,7 +4,7 @@ description: Reference information for evaluator tools.
 template: howto-guide-template
 ---
 
-This guide describes how to resolve problems surrounding the allowed and consistent PHP version being used in different project parts.
+This guide describes how to resolve issues surrounding the allowed and consistent PHP version being used in different project parts.
 
 ## Problem description
 

docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md

@@ -3,7 +3,8 @@ title: Plugin registration with restrictions
 description: Reference information for evaluator tools.
 template: howto-guide-template
 ---
-This guide describes how to fix problems related to plugin registration with restrictions.
+This guide describes how to fix issues related to plugin registration with restrictions.
+
 ## Problem description
 If plugins must be registered in a specific order, `after` and `before` annotations need to be provided in the doc blocks. They must also have specific syntax.
 The annotated class must be imported into the provider class.

docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md

@@ -23,13 +23,13 @@ DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER
 
 ```
 
-In the example, the name is `DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER`. To find the documentation for this error, check the name in the table below.
+In the example, the name is `DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER`. The table bellow describes the error and documentation about it.
 
 <div class="width-100">
 
 
 | Check name  | Error message template                                                   | Documentation                                                                                                                                                                          |
 | ----------- |--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER | The condition statement if {statement} is forbidden in the DependencyProvider | Dependency provider addition logic checker |
+| DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER | The condition statement if {statement} is forbidden in the DependencyProvider | [Dependency provider additional logic checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html) |
 
 </div>