Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev Guidelines Pt2 SEO Update #3001

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ redirect_from:
- /docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.html
related:
- title: Code Quality
link: docs/scos/dev/guidelines/coding-guidelines/code-quality.html
link: docs/dg/dev/guidelines/coding-guidelines/code-quality.html
- title: Code style guide
link: docs/scos/dev/guidelines/coding-guidelines/code-style-guide.html
link: docs/dg/dev/guidelines/coding-guidelines/code-style-guide.html
- title: Secure Coding Practices
link: docs/scos/dev/guidelines/coding-guidelines/secure-coding-practices.html
link: docs/dg/dev/guidelines/coding-guidelines/secure-coding-practices.html
---
This document outlines Spryker recommendations for the code architecture.

Expand Down
8 changes: 4 additions & 4 deletions docs/dg/dev/guidelines/coding-guidelines/code-quality.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Code Quality
description: Spryker Commerce OS’s code base receives very high scores in terms of quality measures, indicating significantly higher code quality than many other ecommerce solutions.
description: Spryker Commerce OS’s code base receives very high scores for quality measures,significantly higher code quality than many other ecommerce solutions.
last_updated: Jun 16, 2021
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/code-quality
Expand All @@ -9,11 +9,11 @@ redirect_from:
- /docs/scos/dev/guidelines/coding-guidelines/code-quality.html
related:
- title: Code Architecture Guide
link: docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.html
link: docs/dg/dev/guidelines/coding-guidelines/code-architecture-guide.html
- title: Code style guide
link: docs/scos/dev/guidelines/coding-guidelines/code-style-guide.html
link: docs/dg/dev/guidelines/coding-guidelines/code-style-guide.html
- title: Secure Coding Practices
link: docs/scos/dev/guidelines/coding-guidelines/secure-coding-practices.html
link: docs/dg/dev/guidelines/coding-guidelines/secure-coding-practices.html
---

Spryker Commerce OS’s code base receives very high scores in terms of quality measures, indicating significantly higher code quality than many other e-commerce solutions.
Expand Down
6 changes: 3 additions & 3 deletions docs/dg/dev/guidelines/coding-guidelines/code-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ redirect_from:
- /docs/scos/dev/guidelines/coding-guidelines/code-style-guide.html
related:
- title: Code Architecture Guide
link: docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.html
link: docs/dg/dev/guidelines/coding-guidelines/code-architecture-guide.html
- title: Code Quality
link: docs/scos/dev/guidelines/coding-guidelines/code-quality.html
link: docs/dg/dev/guidelines/coding-guidelines/code-quality.html
- title: Secure Coding Practices
link: docs/scos/dev/guidelines/coding-guidelines/secure-coding-practices.html
link: docs/dg/dev/guidelines/coding-guidelines/secure-coding-practices.html
---

We at Spryker follow the PSR-2 standards<!-- ](http://www.php-fig.org/psr/psr-2/) check if it works before restoring --> as the coding style guide. To achieve a styled codebase, we integrated the well known [PHP-CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) and [PHPCodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Coding guidelines
description: This document lists coding guidelines that are used at Spryker
description: This document lists everything you need to know about coding guidelines that are used at Spryker for your Spryker based projects.
last_updated: Jan 27, 2022
template: concept-topic-template
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: Secure coding practices for external packages
description: Coding practices for developing your app to ensure its security.
description: Coding practices for developing your app to ensure its security with external packages for your Spryker based projects.
last_updated: Feb 02, 2024
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/secure-coding-practices
originalArticleId: 8c51239e-377e-427a-9d1f-4d15c355fa3c
redirect_from:
related:
- title: Code Architecture Guide
link: docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.html
link: docs/dg/dev/guidelines/coding-guidelines/code-architecture-guide.html
- title: Code Quality
link: docs/scos/dev/guidelines/coding-guidelines/code-quality.html
link: docs/dg/dev/guidelines/coding-guidelines/code-quality.html
- title: Code style guide
link: docs/scos/dev/guidelines/coding-guidelines/code-style-guide.html
link: docs/dg/dev/guidelines/coding-guidelines/code-style-guide.html
- title: Secure Coding Practices
link: docs/scos/dev/guidelines/coding-guidelines/secure-coding-practices.html
link: docs/dg/dev/guidelines/coding-guidelines/secure-coding-practices.html
---
Unsafe coding practices can expose your application to the theft of sensitive data. In this document, we recommend coding practices for developing your app to ensure its security.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Secure Coding Practices
description: Unsafe coding practices can make the software application vulnerable to theft of sensitive data. In this article, we’ll present a series of coding practices that we recommend using when developing an e-commerce application using Spryker Commerce OS, that will keep your software solution secured.
description: In this article, we’ll present a series of coding practices that we recommend using when developing an e-commerce application using Spryker Commerce OS.
last_updated: Jun 16, 2021
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/secure-coding-practices
Expand All @@ -9,11 +9,11 @@ redirect_from:
- /docs/scos/dev/guidelines/coding-guidelines/secure-coding-practices.html
related:
- title: Code Architecture Guide
link: docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.html
link: docs/dg/dev/guidelines/coding-guidelines/code-architecture-guide.html
- title: Code Quality
link: docs/scos/dev/guidelines/coding-guidelines/code-quality.html
link: docs/dg/dev/guidelines/coding-guidelines/code-quality.html
- title: Code style guide
link: docs/scos/dev/guidelines/coding-guidelines/code-style-guide.html
link: docs/dg/dev/guidelines/coding-guidelines/code-style-guide.html
---

Unsafe coding practices can make the software application vulnerable to theft of sensitive data. In this article, we’ll present a series of coding practices that we recommend using when developing an e-commerce application using Spryker Commerce OS, that will keep your software solution secured.
Expand Down
8 changes: 4 additions & 4 deletions docs/dg/dev/guidelines/data-processing-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ redirect_from:
- /docs/scos/dev/guidelines/data-processing-guidelines.html
related:
- title: Making your Spryker shop secure
link: docs/scos/dev/guidelines/security-guidelines.html
link: docs/dg/dev/guidelines/security-guidelines.html
- title: Module configuration convention
link: docs/scos/dev/guidelines/module-configuration-convention.html
link: docs/dg/dev/guidelines/module-configuration-convention.html
- title: Project development guidelines
link: docs/scos/dev/guidelines/project-development-guidelines.html
link: docs/dg/dev/guidelines/project-development-guidelines.html
- title: Data importer speed optimization
link: docs/dg/dev/data-import/page.version/data-import-optimization-guidelines.html
link: docs/dg/dev/data-import/202410.0/data-import-optimization-guidelines.html
---

One of the most important questions addressed during project development is “How to bring data in my project?”. Spryker provides the required infrastructure to address performance and consistency when dealing with project data.
Expand Down
2 changes: 1 addition & 1 deletion docs/dg/dev/guidelines/guidelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Guidelines
description: Guidelines for developers working on Spryker Commerce OS
description: A set of guidelines for developers to use whilst working on Spryker Cloud Commerce OS projects.
template: concept-topic-template
redirect_from:
- /docs/scos/dev/guidelines/guidelines.html
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Event subscribers' registration
description: Extension scenario for the registration of event subscribers
description: Learn about extension scenario for the registration of event subscribers for your Spryker based projects.
last_updated: Mar 13, 2023
template: concept-topic-template
related:
- title: Keeping a project upgradable
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html
- title: Event subscribers registration
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/plugins-registration.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/plugins-registration.html
- title: Modules configuration
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/modules-configuration.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/modules-configuration.html
redirect_from:
- /docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/event-subscribers-registration.html
- /docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/event-subscribers-registration.html
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Modules configuration
description: Modules configuration extension scenario
description: Learn all about how manifests support changes in the configuration files of modules within your Spryker Project.
last_updated: Mar 13, 2023
template: concept-topic-template
related:
- title: Keeping a project upgradable
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html
- title: Plugins registration
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/plugins-registration.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/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
link: ocs/dg/dev/guidelines/keeping-a-project-upgradable/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/extension-scenarios/modules-configuration.html
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Plugins registration
description: Plugins registration extension scenario
description: Learn all about plugins registration extension scenario and how it can support your Spryker based proejct.
last_updated: Mar 13, 2023
template: concept-topic-template
related:
- title: Keeping a project upgradable
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html
- title: Event subscribers registration
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/event-subscribers-registration.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/event-subscribers-registration.html
- title: Modules configuration
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/modules-configuration.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/modules-configuration.html
redirect_from:
- /docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/plugins-registration.html
- /docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/plugins-registration.html
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Ignore evaluation errors
description: Reference information for evaluator configuration file.
description: A short guide detailing the reference information for evaluator configuration file for your Spryker based projects.
template: howto-guide-template
last_updated: Sep 20, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Keeping a project upgradable
description: Guidelines for keeping a project upgradable
description: Helpful guidelines to help keeping your Spryker projects upgradable by keeping them comploant with our development guidelines
last_updated: Mar 24, 2023
template: concept-topic-template
redirect_from:
- /docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html
related:
- title: Plugins registration
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/plugins-registration.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/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
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/event-subscribers-registration.html
- title: Modules configuration
link: docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/modules-configuration.html
link: docs/dg/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/modules-configuration.html
---

Keeping software up to date is often a potential issue, especially when it comes to transactional business models with sophisticated requirements.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Run the evaluator tool
description: Instructions for running the evaluator tool
description: Learn with this guide instructions for running the evaluator tool within your Spryker projects.
template: howto-guide-template
last_updated: Sep 18, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Additional logic in dependency provider
description: Reference information for evaluator tools.
description: Learn about the additional logic in dependency provider and how it checks the way plugins are registered within your Spryker project.
template: howto-guide-template
last_updated: Nov 15, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Container set function
description: Reference information for evaluator tools.
description: Learn about the container set function and how it checks the way plugins are registered in the dependency provider within your Spryker project.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Dead code checker
description: Reference information for evaluator tools.
description: Learn about the dead code checker and how it extends core classes within your Spryker based project.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Discouraged packages checker
description: Reference information for evaluator tools.
description: Learn about the discourage packages checker and how it checksif discouraged packages are installed within your Spryker project.
template: howto-guide-template
last_updated: Nov 10, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Minimum allowed shop version
description: Reference information for evaluator tools.
description: Learn about the minimum allowed shop version checks and how it checks for supported product releases within your Spryker project.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Multidimensional array
description: Reference information for evaluator tools.
description: Learn about the multidimensional array and how it checks that your Spryker project does not use deeply nested multidimensional arrays
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Npm checker
description: Reference information for evaluator tools.
description: Learn about the NPM checker and how it identifies and reports security vulnerabilites in npm dependencies within your Spryker project.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Open-source vulnerabilities checker
description: Reference information for evaluator tools.
description: Open source vulnerabilities checker and how it checks if your PHP application depends on PHP packages with known security issues for your Spryker project.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: PHP version
description: Reference information for evaluator tools.
description: Learn how to resolve issues that occur around the allowed and consistent PHP version being used in your Spryker based projects.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Plugin registration with restrictions
description: Reference information for evaluator tools.
description: Learn how the registration with restrictions plugin checks dependencies between plugins are according to spec within your spryker projects.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Single plugin argument
description: Reference information for evaluator tools.
description: Learn how the single plugin argument checks that plugins do not require complicated constructor arguments within your spryker projects.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Spryker dev packages checker
description: Reference information for evaluator tools.
description: Learn how the Spryker Dev Packages checker and how it checks the project dependencies for constraitns within your spryker projects.
template: howto-guide-template
last_updated: Sep 27, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Spryker security checker
description: Reference information for evaluator tools.
description: Learn how the Spryker security checker and how it checks if security fixes exist for modules present within your spryker projects.
template: howto-guide-template
last_updated: Oct 24, 2023
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Upgradability guidelines
description: Find solutions to Evaluator violations
description: Spryker upgradability guidelines and how to resolve issues related to code evaluation to help keep your code inline with Spryker and industry standards.
template: howto-guide-template
last_updated: Nov 16, 2023
redirect_from:
Expand Down
Loading