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 Pt1 SEO Update #2999

Merged
merged 7 commits into from
Jan 16, 2025
Merged
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
2 changes: 1 addition & 1 deletion docs/dg/dev/guidelines/module-configuration-convention.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Module configuration convention
description: This article contains conventions on the module configuration.
description: Learn in this article about Spryker conventions on the module configuration for your Spryker based projects
last_updated: Jun 16, 2021
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/module-configuration-convention
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ redirect_from:
- /docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.html
related:
- title: General performance guidelines
link: docs/scos/dev/guidelines/performance-guidelines/general-performance-guidelines.html
link: docs/dg/dev/guidelines/performance-guidelines/general-performance-guidelines.html
- title: Frontend performance guidelines
link: docs/scos/dev/guidelines/performance-guidelines/front-end-performance-guidelines.html
link: docs/dg/dev/guidelines/performance-guidelines/front-end-performance-guidelines.html
---

Performance shows the response of a system to carrying out certain actions for a certain period. Performance is an important quality attribute in each application architecture that can impact user experience behavior and business revenues. Therefore, we highly recommend following the best practices and avoiding performance drawbacks in the architecture design.
Expand Down Expand Up @@ -265,4 +265,4 @@ We strongly recommend our customers enable APM systems for their projects. Spryk

### Performance CI

Performance CI plays a very important role for each project pipeline as it prevents new issues in the long term when it comes to feature development. To analyze your project's performance, you can use the [Benchmark](/docs/scos/dev/sdk/development-tools/performance-audit-tool-benchmark.html) tool.
Performance CI plays a very important role for each project pipeline as it prevents new issues in the long term when it comes to feature development. To analyze your project's performance, you can use the [Benchmark](/docs/dg/dev/sdks/sdk/development-tools/benchmark-performance-audit-tool.html) tool.
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: New Relic transactions grouping by queue names
description: Enhanced New Relic queue flow groups transactions by queue names.
description: Learn about Enhanced New Relic queue flow groups transactions by queue names for your Spryker based projects.
last_updated: May 16, 2022
template: concept-topic-template
redirect_from:
- /docs/scos/dev/guidelines/performance-guidelines/elastic-computing/scalable-application-infrastructure-for-publish-and-sync-workers.html
related:
- title: RAM-aware batch processing
link: docs/scos/dev/guidelines/performance-guidelines/elastic-computing/ram-aware-batch-processing.html
link: docs/dg/dev/guidelines/performance-guidelines/elastic-computing/ram-aware-batch-processing.html
- title: Storage caching for primary-replica database setups
link: docs/scos/dev/guidelines/performance-guidelines/elastic-computing/storage-caching-for-primary-replica-db-setups.html
link: docs/dg/dev/guidelines/performance-guidelines/elastic-computing/storage-caching-for-primary-replica-db-setups.html
redirect_from:
- /docs/scos/dev/guidelines/performance-guidelines/elastic-computing/scalable-application-infrastructure-for-publish-and-sync-workers.html
- /docs/scos/dev/guidelines/performance-guidelines/elastic-computing/new-relic-transaction-grouping-by-queue-names.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ redirect_from:
- /docs/scos/dev/guidelines/performance-guidelines/elastic-computing/ram-aware-batch-processing.html
related:
- title: New Relic transactions grouping by queue names
link: docs/scos/dev/guidelines/performance-guidelines/elastic-computing/new-relic-transaction-grouping-by-queue-names.html
link: docs/dg/dev/guidelines/performance-guidelines/elastic-computing/new-relic-transaction-grouping-by-queue-names.html
- title: Storage caching for primary-replica database setups
link: docs/scos/dev/guidelines/performance-guidelines/elastic-computing/storage-caching-for-primary-replica-db-setups.html
link: docs/dg/dev/guidelines/performance-guidelines/elastic-computing/storage-caching-for-primary-replica-db-setups.html
---

Long-running PHP operations like data import may consume a considerable amount of memory during execution. However, in some cases, a significant amount of available memory is not used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ redirect_from:
- /docs/scos/dev/guidelines/performance-guidelines/elastic-computing/storage-caching-for-primary-replica-db-setups.html
related:
- title: New Relic transactions grouping by queue names
link: docs/scos/dev/guidelines/performance-guidelines/elastic-computing/new-relic-transaction-grouping-by-queue-names.html
link: docs/dg/dev/guidelines/performance-guidelines/elastic-computing/new-relic-transaction-grouping-by-queue-names.html
- title: RAM-aware batch processing
link: docs/scos/dev/guidelines/performance-guidelines/elastic-computing/ram-aware-batch-processing.html
link: docs/dg/dev/guidelines/performance-guidelines/elastic-computing/ram-aware-batch-processing.html
---

With database replication enabled, there is a time gap between adding data to the primary database (DB) and transferring data to the replica. So, the application may fail to read the data from the replica.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Frontend performance guidelines
description: Optimize your Spryker Frontend.
description: Learn how you can optimize your Spryker Frontend performance and some general guidelines for your Spryker based projects.
last_updated: Jun 16, 2021
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/front-end-performance-guidelines
Expand All @@ -11,9 +11,9 @@ redirect_from:
- /docs/scos/dev/tuning-up-performance/202204.0/performance-guidelines.html#frontend-performance
related:
- title: General performance guidelines
link: docs/scos/dev/guidelines/performance-guidelines/general-performance-guidelines.html
link: docs/dg/dev/guidelines/performance-guidelines/general-performance-guidelines.html
- title: Architecture performance guidelines
link: docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.html
link: docs/dg/dev/guidelines/performance-guidelines/architecture-performance-guidelines.html
---

This document describes general and Spryker-specific frontend performance guidelines.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: General performance guidelines
description: This guideline explains how to optimize the server-side execution time.
description: This guideline explains how to optimize the server-side execution time for your Spryker based projects.
last_updated: Jun 16, 2021
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/performance-guidelines
Expand All @@ -11,13 +11,13 @@ redirect_from:
- /docs/scos/dev/tuning-up-performance/202204.0/performance-guidelines.html
related:
- title: Architecture performance guidelines
link: docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.html
link: docs/dg/dev/guidelines/performance-guidelines/architecture-performance-guidelines.html
- title: Frontend performance guidelines
link: docs/scos/dev/guidelines/performance-guidelines/front-end-performance-guidelines.html
link: docs/dg/dev/guidelines/performance-guidelines/front-end-performance-guidelines.html
- title: Web Profiler Widget for Yves
link: docs/scos/dev/technical-enhancement-integration-guides/integrating-development-tools/integrating-web-profiler-widget-for-yves.html
link: docs/dg/dev/integrate-and-configure/integrate-development-tools/integrate-web-profiler-widget-for-yves.html
- title: Web Profiler for Zed
link: docs/scos/dev/technical-enhancement-integration-guides/integrating-development-tools/integrating-web-profiler-for-zed.html
link: docs/dg/dev/integrate-and-configure/integrate-development-tools/integrate-web-profiler-for-zed.html
---

Spryker is a fast application by design. These guidelines explain how to optimize the server-side execution time.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Performance guidelines
description: This guidelines explains how to optimize the performance of your website.
description: This guidelines explains how to optimize the performance of your website for your Spryker based Projects.
template: concept-topic-template
redirect_from:
- /docs/scos/dev/tuning-up-performance/202204.0/performance-guidelines.html
Expand Down
2 changes: 1 addition & 1 deletion docs/dg/dev/guidelines/security-guidelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Security guidelines
description: Explore operational and deployment guidelines for efficient ecommerce system management. Focus on best practices for deployment, monitoring, and scaling infrastructure.
description: Learn about the data security guidelines that you need to follow on an application level for your Spryker based projects.
last_updated: Sep 15, 2023
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/making-your-spryker-shop-secure
Expand Down
24 changes: 12 additions & 12 deletions docs/dg/dev/guidelines/testing-guidelines/code-coverage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Code coverage
description: Learn how to generate the code coverage report.
description: Learn how to generate the code coverage report in HTML for your testing capabilities in your Spryker Development
last_updated: Jun 16, 2021
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/code-coverage
Expand All @@ -10,27 +10,27 @@ redirect_from:
- /docs/scos/dev/guidelines/testing/code-coverage.html
related:
- title: Available test helpers
link: docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html
link: docs/dg/dev/guidelines/testing-guidelines/test-helpers/test-helpers.html
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
link: docs/dg/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/testing-the-publish-and-synchronization-process.html
- title: Setting up tests
link: docs/scos/dev/guidelines/testing-guidelines/setting-up-tests.html
link: docs/dg/dev/guidelines/testing-guidelines/setting-up-tests.html
- title: Test framework
link: docs/scos/dev/guidelines/testing-guidelines/test-framework.html
link: docs/dg/dev/guidelines/testing-guidelines/test-framework.html
- title: Test helpers
link: docs/scos/dev/guidelines/testing-guidelines/test-helpers.html
link: docs/dg/dev/guidelines/testing-guidelines/test-helpers/using-test-helpers.html
- title: Testify
link: docs/scos/dev/guidelines/testing-guidelines/testify.html
link: docs/dg/dev/guidelines/testing-guidelines/testify.html
- title: Testing best practices
link: docs/scos/dev/guidelines/testing-guidelines/testing-best-practices.html
link: docs/dg/dev/guidelines/testing-guidelines/testing-best-practices/best-practices-for-effective-testing.html
- title: Testing concepts
link: docs/scos/dev/guidelines/testing-guidelines/testing-concepts.html
link: docs/dg/dev/guidelines/testing-guidelines/testing-best-practices/testing-concepts.html
- title: Testing console commands
link: docs/scos/dev/guidelines/testing-guidelines/testing-console-commands.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/test-console-commands.html
---

To be aware of what you are testing, you should know the code coverage. To get the code coverage report generated, make sure Xdebug is enabled and run your tests with an additional flag:
Expand Down
22 changes: 11 additions & 11 deletions docs/dg/dev/guidelines/testing-guidelines/data-builders.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,27 @@ redirect_from:
- /docs/scos/dev/guidelines/testing/data-builders.html
related:
- title: Available test helpers
link: docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html
link: docs/dg/dev/guidelines/testing-guidelines/test-helpers/test-helpers.html
- title: Code coverage
link: docs/scos/dev/guidelines/testing-guidelines/code-coverage.html
link: docs/dg/dev/guidelines/testing-guidelines/code-coverage.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/testing-the-publish-and-synchronization-process.html
- title: Setting up tests
link: docs/scos/dev/guidelines/testing-guidelines/setting-up-tests.html
link: docs/dg/dev/guidelines/testing-guidelines/setting-up-tests.html
- title: Test framework
link: docs/scos/dev/guidelines/testing-guidelines/test-framework.html
link: docs/dg/dev/guidelines/testing-guidelines/test-framework.html
- title: Test helpers
link: docs/scos/dev/guidelines/testing-guidelines/test-helpers.html
link: docs/dg/dev/guidelines/testing-guidelines/test-helpers/using-test-helpers.html
- title: Testify
link: docs/scos/dev/guidelines/testing-guidelines/testify.html
link: docs/dg/dev/guidelines/testing-guidelines/testify.html
- title: Testing best practices
link: docs/scos/dev/guidelines/testing-guidelines/testing-best-practices.html
link: docs/dg/dev/guidelines/testing-guidelines/testing-best-practices/best-practices-for-effective-testing.html
- title: Testing concepts
link: docs/scos/dev/guidelines/testing-guidelines/testing-concepts.html
link: docs/dg/dev/guidelines/testing-guidelines/testing-best-practices/testing-concepts.html
- title: Testing console commands
link: docs/scos/dev/guidelines/testing-guidelines/testing-console-commands.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/test-console-commands.html
---

Data builders help you create transfer objects for your tests. Instead of preparing transfers each time you need them, data builders do the work for you. Data builders use the [Faker library](https://github.com/fzaninotto/Faker).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Execute tests
description: Lean what commands you can use to execute your tests.
description: Learn what commands you can use to execute your tests. You can run all tests or specific ones within your Spryker Based Projects.
last_updated: Jun 16, 2021
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/executing-tests
Expand All @@ -10,27 +10,27 @@ redirect_from:
- /docs/scos/dev/guidelines/testing/executing-tests.html
related:
- title: Available test helpers
link: docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html
link: docs/dg/dev/guidelines/testing-guidelines/test-helpers/test-helpers.html
- title: Code coverage
link: docs/scos/dev/guidelines/testing-guidelines/code-coverage.html
link: docs/dg/dev/guidelines/testing-guidelines/code-coverage.html
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
link: docs/dg/dev/guidelines/testing-guidelines/data-builders.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/testing-the-publish-and-synchronization-process.html
- title: Setting up tests
link: docs/scos/dev/guidelines/testing-guidelines/setting-up-tests.html
link: docs/dg/dev/guidelines/testing-guidelines/setting-up-tests.html
- title: Test framework
link: docs/scos/dev/guidelines/testing-guidelines/test-framework.html
link: docs/dg/dev/guidelines/testing-guidelines/test-framework.html
- title: Test helpers
link: docs/scos/dev/guidelines/testing-guidelines/test-helpers.html
link: docs/dg/dev/guidelines/testing-guidelines/test-helpers/using-test-helpers.html
- title: Testify
link: docs/scos/dev/guidelines/testing-guidelines/testify.html
link: docs/dg/dev/guidelines/testing-guidelines/testify.html
- title: Testing best practices
link: docs/scos/dev/guidelines/testing-guidelines/testing-best-practices.html
link: docs/dg/dev/guidelines/testing-guidelines/testing-best-practices/best-practices-for-effective-testing.html
- title: Testing concepts
link: docs/scos/dev/guidelines/testing-guidelines/testing-concepts.html
link: docs/dg/dev/guidelines/testing-guidelines/testing-best-practices/testing-concepts.html
- title: Testing console commands
link: docs/scos/dev/guidelines/testing-guidelines/testing-console-commands.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/test-console-commands.html
---

There are many ways to execute the [tests](/docs/dg/dev/guidelines/testing-guidelines/test-framework.html). You can do a full run of all tests, or you can narrow it down to only execute a specific test method.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
---
title: Test console commands
description: How to test console commands.
description: Learn how to test console commands with test helpers using ConsoleHelper in your Spryker based projects.
last_updated: Jan 12, 2022
template: concept-topic-template
redirect_from:
related:
- title: Available test helpers
link: docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html
link: docs/dg/dev/guidelines/testing-guidelines/test-helpers/test-helpers.html
- title: Code coverage
link: docs/scos/dev/guidelines/testing-guidelines/code-coverage.html
link: docs/dg/dev/guidelines/testing-guidelines/code-coverage.html
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
link: docs/dg/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
link: docs/dg/dev/guidelines/testing-guidelines/executing-tests/testing-the-publish-and-synchronization-process.html
- title: Setting up tests
link: docs/scos/dev/guidelines/testing-guidelines/setting-up-tests.html
link: docs/dg/dev/guidelines/testing-guidelines/setting-up-tests.html
- title: Test framework
link: docs/scos/dev/guidelines/testing-guidelines/test-framework.html
link: docs/dg/dev/guidelines/testing-guidelines/test-framework.html
- title: Test helpers
link: docs/scos/dev/guidelines/testing-guidelines/test-helpers.html
link: docs/dg/dev/guidelines/testing-guidelines/test-helpers/using-test-helpers.html
- title: Testify
link: docs/scos/dev/guidelines/testing-guidelines/testify.html
link: docs/dg/dev/guidelines/testing-guidelines/testify.html
- title: Testing best practices
link: docs/scos/dev/guidelines/testing-guidelines/testing-best-practices.html
link: docs/dg/dev/guidelines/testing-guidelines/testing-best-practices/best-practices-for-effective-testing.html
- title: Testing concepts
link: docs/scos/dev/guidelines/testing-guidelines/testing-concepts.html
link: docs/dg/dev/guidelines/testing-guidelines/testing-best-practices/testing-concepts.html
redirect_from:
- /docs/scos/dev/guidelines/testing-guidelines/testing-console-commands.html
- /docs/scos/dev/guidelines/testing-guidelines/executing-tests/test-console-commands.html
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Test Glue API
description: Learn how to test Glue API
description: Use this guide to Learn how to test Glue API End to end within your Spryker based projects.
template: howto-guide-template
last_updated: Jan 9, 2024
redirect_from:
Expand Down
Loading
Loading