Skip to content

Commit

Permalink
fix-links
Browse files Browse the repository at this point in the history
  • Loading branch information
@andriitserkovnyi
andriitserkovnyi committed May 3, 2022
1 parent 7722107 commit 824ea1d
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions ...cos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ analyze:php:code-compliance
analyze:php:code-compliance-report
```
For detailed instructions, see [Running the evaluator tool](/docs/scos/dev/keeping-a-project-upgradable/running-the-evaluator-tool.html).
For detailed instructions, see [Running the evaluator tool](/docs/scos/dev/guidelines/keeping-a-project-upgradable/running-the-evaluator-tool.html).
## 4. Resolve the evaluation issues
If Evaluator detects compliance issues, resolve them by using the instructions in [Upgradability guidelines](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.html).
If Evaluator detects compliance issues, resolve them by using the instructions in [Upgradability guidelines](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.html).
## 5. Update your project
Expand Down
30 changes: 15 additions & 15 deletions ...eping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ In the example, the name is `PrivateApi:Extension`. To find the documentation fo

| Group name | Group description | Check name | Error message template | Documentation |
| ----------- | ----------- | ----------- | ----------- | ----------- |
| NotUnique | Covers the cases related to project-level entity names that can conflict with the entity names on the core level. | NotUnique:TransferName | Transfer object name `{transfer_name}` has to have project prefix Pyz in **{absolute_transfer_path}**, like **Pyz{transfer_name}** | [Transfer name is not unique](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#transfer-name-is-not-unique) |
| NotUnique | | NotUnique:TransferProperty | Transfer property `{transfer_property_name}` for `{transfer}` has to have project prefix Pyz in **{absolute_transfer_path}**, like **pyz{transfer_property_name}** | [Transfer property name is not unique](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#transfer-property-name-is-not-unique) |
| NotUnique | | NotUnique:DatabaseTable | Database table **{table_name}** has to have project prefix Pyz in **{absolute_schema_path}**, like **pyz_{table_name}**| [Database table name is not unique](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#database-table-name-is-not-unique) |
| NotUnique | | NotUnique:DatabaseColumn | Database column **{table_column_name}** has to have project prefix Pyz in **{absolute_schema_path}**, like **pyz_{table_column_name}** | [Name of database table column is not unique](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#name-of-database-table-column-is-not-unique) |
| NotUnique | | NotUnique:Method | Method name **{class}::{method_name}** should contains project prefix, like **{method_name_with_prefix}** | [Method name is not unique](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#method-name-is-not-unique) |
| NotUnique | | NotUnique:Constant | **{class_name}::{constant_name}** name has to have project namespace, like **PYZ_{constant_name}**.| [Constant name is not unique](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#constant-name-is-not-unique) |
| PrivateApi | Covers the cases related to project-level code using core dependencies that can be potentially removed in minor or major versions. | PrivateApi:Dependency | Avoid this dependency: **{dependency_provider_class_name}::{dependency_name_constant}** | [Private API is extended](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:MethodIsOverwritten | Please avoid usage of core method **{class_namespace}::{method_name}** in the class **{class_namespace}** | [Private API method is overridden on the project level](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-method-is-overridden-on-the-project-level.html) |
| PrivateApi | | PrivateApi:Extension | Please avoid extension of the PrivateApi **{class_name}** in **{class_name}** | [Private API method is overridden on the project level](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-method-is-overridden-on-the-project-level.html) |
| PrivateApi | | PrivateApi:Persistence | Please avoid Spryker dependency: $this->**{method_name}**(...) | [private-api-is-used-on-the-project-level](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-used-on-the-project-level.html) |
| PrivateApi | | PrivateApi:CorePersistenceUsage | Please avoid usage of PrivateApi method **{method_name}** in **{class_namespace}** | [Private API is extended](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:PrivateApiDependencyInBusinessModel | Please avoid Spryker dependency: **{class_namespace}** in **{class_namespace}** | [Private API is extended](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:Facade | Please avoid Spryker dependency: **{method_name}** | [Private API is extended](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:ObjectInitialization | Please avoid Spryker dependency: **{class_namespace}** in **{class_namespace}** | [Private API is extended](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:PersistenceInBusinessModel | Please avoid Spryker dependency: **{object_name}**->**{method_name}(...)** | [Private API is extended](/docs/scos/dev/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| NotUnique | Covers the cases related to project-level entity names that can conflict with the entity names on the core level. | NotUnique:TransferName | Transfer object name `{transfer_name}` has to have project prefix Pyz in **{absolute_transfer_path}**, like **Pyz{transfer_name}** | [Transfer name is not unique](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#transfer-name-is-not-unique) |
| NotUnique | | NotUnique:TransferProperty | Transfer property `{transfer_property_name}` for `{transfer}` has to have project prefix Pyz in **{absolute_transfer_path}**, like **pyz{transfer_property_name}** | [Transfer property name is not unique](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#transfer-property-name-is-not-unique) |
| NotUnique | | NotUnique:DatabaseTable | Database table **{table_name}** has to have project prefix Pyz in **{absolute_schema_path}**, like **pyz_{table_name}**| [Database table name is not unique](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#database-table-name-is-not-unique) |
| NotUnique | | NotUnique:DatabaseColumn | Database column **{table_column_name}** has to have project prefix Pyz in **{absolute_schema_path}**, like **pyz_{table_column_name}** | [Name of database table column is not unique](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#name-of-database-table-column-is-not-unique) |
| NotUnique | | NotUnique:Method | Method name **{class}::{method_name}** should contains project prefix, like **{method_name_with_prefix}** | [Method name is not unique](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#method-name-is-not-unique) |
| NotUnique | | NotUnique:Constant | **{class_name}::{constant_name}** name has to have project namespace, like **PYZ_{constant_name}**.| [Constant name is not unique](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/entity-name-is-not-unique.html#constant-name-is-not-unique) |
| PrivateApi | Covers the cases related to project-level code using core dependencies that can be potentially removed in minor or major versions. | PrivateApi:Dependency | Avoid this dependency: **{dependency_provider_class_name}::{dependency_name_constant}** | [Private API is extended](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:MethodIsOverwritten | Please avoid usage of core method **{class_namespace}::{method_name}** in the class **{class_namespace}** | [Private API method is overridden on the project level](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-method-is-overridden-on-the-project-level.html) |
| PrivateApi | | PrivateApi:Extension | Please avoid extension of the PrivateApi **{class_name}** in **{class_name}** | [Private API method is overridden on the project level](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-method-is-overridden-on-the-project-level.html) |
| PrivateApi | | PrivateApi:Persistence | Please avoid Spryker dependency: $this->**{method_name}**(...) | [private-api-is-used-on-the-project-level](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-used-on-the-project-level.html) |
| PrivateApi | | PrivateApi:CorePersistenceUsage | Please avoid usage of PrivateApi method **{method_name}** in **{class_namespace}** | [Private API is extended](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:PrivateApiDependencyInBusinessModel | Please avoid Spryker dependency: **{class_namespace}** in **{class_namespace}** | [Private API is extended](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:Facade | Please avoid Spryker dependency: **{method_name}** | [Private API is extended](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:ObjectInitialization | Please avoid Spryker dependency: **{class_namespace}** in **{class_namespace}** | [Private API is extended](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
| PrivateApi | | PrivateApi:PersistenceInBusinessModel | Please avoid Spryker dependency: **{object_name}**->**{method_name}(...)** | [Private API is extended](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/private-api-is-extended.html) |
8 changes: 4 additions & 4 deletions docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-services.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ The evaluator tool checks the following:

To learn more about the evaluator tool, see the following documents:

- [evaluator tool overview](/docs/scos/dev/keeping-a-project-upgradable/evaluator-tool-overview.html)
- [Running the evaluator tool](/docs/scos/dev/keeping-a-project-upgradable/running-the-evaluator-tool.html)
- [evaluator tool overview](/docs/scos/dev/guidelines/keeping-a-project-upgradable/evaluator-tool-overview.html)
- [Running the evaluator tool](/docs/scos/dev/guidelines/keeping-a-project-upgradable/running-the-evaluator-tool.html)



Expand All @@ -73,5 +73,5 @@ The upgrader tool checks your project’s code against our latest released code.

To learn more about the evaluator tool, see the following documents:

* [upgrader tool overview](/docs/scos/dev/keeping-a-project-upgradable/upgrader-tool-overview.html)
* [Running the upgrader tool](/docs/scos/dev/keeping-a-project-upgradable/running-the-upgrader-tool.html)
* [upgrader tool overview](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgrader-tool-overview.html)
* [Running the upgrader tool](/docs/scos/dev/guidelines/keeping-a-project-upgradable/running-the-upgrader-tool.html)
2 changes: 1 addition & 1 deletion docs/scos/dev/guidelines/keeping-a-project-upgradable/upgrader-tool-overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ For example, if at step 6, due to incorrect authentication details, the upgrader

## Next steps

[Running the upgrader tool](/docs/scos/dev/keeping-a-project-upgradable/running-the-upgrader-tool.html)
[Running the upgrader tool](/docs/scos/dev/guidelines/keeping-a-project-upgradable/running-the-upgrader-tool.html)

0 comments on commit 824ea1d

Please sign in to comment.