Skip to content

Revisions for the modular development tutorial #23128

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

Merged
merged 35 commits into from
Jun 22, 2025

Conversation

EngincanV
Copy link
Member

@EngincanV EngincanV commented Jun 20, 2025

Resolves #23072

The sample application is also updated: abpframework/abp-samples#295

@EngincanV EngincanV added this to the 10.0-preview milestone Jun 20, 2025
@EngincanV EngincanV requested review from hikalkan and Copilot June 20, 2025 13:15
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Modular CRM tutorial to rename and refactor references from "Products" to "Catalog" for consistency and refreshes module names and sample code. Key changes:

  • Renamed all mentions of the Products module to Catalog across tutorial parts and navigation.
  • Updated namespaces and package references in code examples to reflect the Catalog module.
  • Added null-forgiving initializers to DTO properties and adjusted download link to new sample path.

Reviewed Changes

Copilot reviewed 10 out of 41 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/en/tutorials/modular-crm/index.md Updated tutorial nav and download link to reflect Catalog naming.
docs/en/tutorials/modular-crm/part-01.md Added initial modularity step details and Catalog module setup.
docs/en/tutorials/modular-crm/part-02.md Renamed Products to Catalog in installation instructions.
docs/en/tutorials/modular-crm/part-03.md Renamed Products module to Catalog module throughout.
docs/en/tutorials/modular-crm/part-04.md Adjusted summary and module creation text for consistency.
docs/en/tutorials/modular-crm/part-05.md Changed service and DTO namespaces to Ordering.Contracts.Enums.
docs/en/tutorials/modular-crm/part-06.md Updated integration service references from Products to Catalog.
docs/en/tutorials/modular-crm/part-07.md Switched event subscriber code examples from Products to Catalog.
docs/en/tutorials/modular-crm/part-08.md Refactored reporting service examples to Catalog and added DTO defaults.
docs/en/docs-nav.json Updated docs navigation entries for Catalog module parts.
Comments suppressed due to low confidence (3)

docs/en/tutorials/modular-crm/part-08.md:61

  • The interface code snippet defines Task<List<OrderReportDto>> but is missing using System.Threading.Tasks; and using System.Collections.Generic;. Add these directives so the interface compiles.
using ModularCrm.Orders;

docs/en/tutorials/modular-crm/part-08.md:106

  • This import should reference the actual integration service contract namespace (e.g., ModularCrm.Catalog.Integration or ModularCrm.Catalog.Contracts.Services) rather than the root module namespace.
using ModularCrm.Catalog;

docs/en/tutorials/modular-crm/part-08.md:106

  • The service example code uses Task and List, but the snippet has removed using System;, using System.Collections.Generic;, using System.Linq;, and using System.Threading.Tasks;. Re-add those imports above to avoid compile errors.
using ModularCrm.Catalog;

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 22.2%, saving 868.57 KB.

Filename Before After Improvement Visual comparison
docs/en/studio/images/solution-runner/csharp-application-context-menu-build.png 44.77 KB 29.92 KB -33.2% View diff
docs/en/studio/images/solution-runner/csharp-application-context-menu-monitor.png 29.00 KB 19.28 KB -33.5% View diff
docs/en/studio/images/solution-runner/csharp-application-context-menu.png 32.43 KB 21.49 KB -33.8% View diff
docs/en/studio/images/solution-runner/docker-container-example-add-dialog.png 12.89 KB 10.03 KB -22.2% View diff
docs/en/studio/images/solution-runner/docker-container-example-add.png 10.95 KB 7.19 KB -34.4% View diff
docs/en/studio/images/solution-runner/docker-container-example-rabbitmq.png 14.18 KB 12.83 KB -9.5% View diff
docs/en/studio/images/solution-runner/docker-container-properties.png 10.60 KB 8.48 KB -20.0% View diff
docs/en/studio/images/solution-runner/docker-container-stack.png 17.33 KB 11.35 KB -34.5% View diff
docs/en/studio/images/solution-runner/docker-container-warning.png 4.12 KB 2.61 KB -36.6% View diff
docs/en/studio/images/solution-runner/folder-context-menu.png 18.79 KB 12.79 KB -32.0% View diff
docs/en/studio/images/solution-runner/profile-root-context-menu.png 31.72 KB 20.68 KB -34.8% View diff
docs/en/studio/images/solution-runner/solution-runner.png 46.90 KB 31.88 KB -32.0% View diff
docs/en/tutorials/microservice/images/abp-studio-solution-runner-play-all.png 48.35 KB 32.86 KB -32.0% View diff
docs/en/tutorials/modular-crm/images/abp-studio-add-entity-framework-core-migration.png 43.35 KB 28.65 KB -33.9% View diff
docs/en/tutorials/modular-crm/images/abp-studio-add-new-folder-command-2.png 31.85 KB 20.32 KB -36.2% View diff
docs/en/tutorials/modular-crm/images/abp-studio-add-package-reference-4.png 62.33 KB 41.50 KB -33.4% View diff
docs/en/tutorials/modular-crm/images/abp-studio-add-package-reference-dialog-3.png 68.74 KB 46.95 KB -31.7% View diff
docs/en/tutorials/modular-crm/images/abp-studio-add-package-reference-dialog-4.png 77.59 KB 53.06 KB -31.6% View diff
docs/en/tutorials/modular-crm/images/abp-studio-browser-list-of-orders-with-product-name.png 82.51 KB 55.86 KB -32.3% View diff
docs/en/tutorials/modular-crm/images/abp-studio-browser-list-of-products.png 70.04 KB 50.34 KB -28.1% View diff
docs/en/tutorials/modular-crm/images/abp-studio-browser-orders-menu-item.png 105.00 KB 73.95 KB -29.6% View diff
docs/en/tutorials/modular-crm/images/abp-studio-build-and-restart-application.png 24.14 KB 15.88 KB -34.2% View diff
docs/en/tutorials/modular-crm/images/abp-studio-entity-framework-core-update-database.png 43.42 KB 28.68 KB -34.0% View diff
docs/en/tutorials/modular-crm/images/abp-studio-graph-build.png 44.31 KB 29.90 KB -32.5% View diff
docs/en/tutorials/modular-crm/images/abp-studio-import-module-dialog-for-catalog.png 50.63 KB 36.77 KB -27.4% View diff
docs/en/tutorials/modular-crm/images/abp-studio-import-module-for-ordering-dialog.png 60.17 KB 42.51 KB -29.4% View diff
docs/en/tutorials/modular-crm/images/abp-studio-import-module-ordering.png 32.57 KB 21.34 KB -34.5% View diff
docs/en/tutorials/modular-crm/images/abp-studio-imports-and-dependencies.png 60.21 KB 39.84 KB -33.8% View diff
docs/en/tutorials/modular-crm/images/abp-studio-install-module-dialog-for-ordering.png 107.30 KB 77.72 KB -27.6% View diff
docs/en/tutorials/modular-crm/images/abp-studio-modular-crm-with-standard-module.png 39.24 KB 25.82 KB -34.2% View diff
docs/en/tutorials/modular-crm/images/abp-studio-module-installation-dialog-for-catalog.png 83.70 KB 61.97 KB -26.0% View diff
docs/en/tutorials/modular-crm/images/abp-studio-open-with-visual-studio-catalog.png 48.26 KB 31.78 KB -34.2% View diff
docs/en/tutorials/modular-crm/images/abp-studio-open-with-visual-studio-code-catalog.png 48.24 KB 31.84 KB -34.0% View diff
docs/en/tutorials/modular-crm/images/abp-studio-solution-runner-initial-catalog-page.png 99.27 KB 66.95 KB -32.6% View diff
docs/en/tutorials/modular-crm/images/abp-studio-swagger-ui-create-product-execute.png 47.19 KB 33.31 KB -29.4% View diff
docs/en/tutorials/modular-crm/images/abp-studio-swagger-ui-create-product-try.png 48.29 KB 32.76 KB -32.2% View diff
docs/en/tutorials/modular-crm/images/abp-studio-swagger-ui-in-browser.png 96.65 KB 66.71 KB -31.0% View diff
docs/en/tutorials/modular-crm/images/catalog-module-vs-code.png 27.27 KB 14.60 KB -46.4% View diff
docs/en/tutorials/modular-crm/images/modular-crm-wizard-modularity-step.png 93.75 KB 65.89 KB -29.7% View diff
docs/en/tutorials/modular-crm/images/solution-explorer-modular-crm-initial-with-modules.png 44.82 KB 29.52 KB -34.1% View diff
docs/en/tutorials/modular-crm/images/visual-studio-order-event-handler.png 54.83 KB 29.99 KB -45.3% View diff
docs/en/tutorials/modular-crm/images/vs-code-catalog-contracts.png 121.12 KB 66.00 KB -45.5% View diff
docs/en/tutorials/modular-crm/images/vscode-catalog-cshtml.png 43.16 KB 22.87 KB -47.0% View diff
docs/en/tutorials/modular-crm/images/vscode-product-integration-service.png 48.13 KB 25.51 KB -47.0% View diff
docs/en/ui-themes/lepton-x/images/account-layout-background-style.png 1.65 MB 1.52 MB -7.6% View diff

2875 images did not require optimisation.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 31%, saving 3.39 KB.

Filename Before After Improvement Visual comparison
docs/en/tutorials/modular-crm/images/abp-studio-solution-explorer-with-folders-v2.png 10.95 KB 7.56 KB -31.0% View diff

2920 images did not require optimisation.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 37.7%, saving 22.10 KB.

Filename Before After Improvement Visual comparison
docs/en/tutorials/modular-crm/images/sql-server-products-database-table-filled-v2.png 53.18 KB 33.05 KB -37.9% View diff
docs/en/tutorials/modular-crm/images/sql-server-products-database-table-v2.png 5.39 KB 3.42 KB -36.5% View diff

2919 images did not require optimisation.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 24.9%, saving 11.62 KB.

Filename Before After Improvement Visual comparison
docs/en/tutorials/modular-crm/images/abp-studio-install-module-dialog-v2.png 46.68 KB 35.06 KB -24.9% View diff

2920 images did not require optimisation.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 32.9%, saving 16.61 KB.

Filename Before After Improvement Visual comparison
docs/en/tutorials/modular-crm/images/abp-studio-entity-framework-core-add-migration-order-v2.png 11.92 KB 8.58 KB -28.0% View diff
docs/en/tutorials/modular-crm/images/sql-server-orders-database-table-v2.png 6.91 KB 4.58 KB -33.7% View diff
docs/en/tutorials/modular-crm/images/visual-studio-new-migration-class-2-v2.png 14.37 KB 9.25 KB -35.6% View diff
docs/en/tutorials/modular-crm/images/visual-studio-order-entity-v2.png 17.23 KB 11.41 KB -33.8% View diff

2917 images did not require optimisation.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 33.5%, saving 69.53 KB.

Filename Before After Improvement Visual comparison
docs/en/tutorials/modular-crm/images/abp-studio-browser-orders-menu-item-v2.png 57.56 KB 40.95 KB -28.9% View diff
docs/en/tutorials/modular-crm/images/abp-studio-ordering-swagger-ui-in-browser-v2.png 51.56 KB 36.13 KB -29.9% View diff
docs/en/tutorials/modular-crm/images/abp-studio-swagger-ui-create-order-execute-v2.png 19.03 KB 11.30 KB -40.6% View diff
docs/en/tutorials/modular-crm/images/sql-server-orders-database-table-filled-v2.png 65.02 KB 40.38 KB -37.9% View diff
docs/en/tutorials/modular-crm/images/visual-studio-ordering-contracts-v2.png 14.46 KB 9.33 KB -35.5% View diff

2916 images did not require optimisation.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 32.3%, saving 9.43 KB.

Filename Before After Improvement Visual comparison
docs/en/tutorials/modular-crm/images/abp-studio-add-package-reference-4-v2.png 29.21 KB 19.78 KB -32.3% View diff

2920 images did not require optimisation.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 28.8%, saving 28.52 KB.

Filename Before After Improvement Visual comparison
docs/en/tutorials/modular-crm/images/abp-studio-imports-and-dependencies-v2.png 33.48 KB 22.36 KB -33.2% View diff
docs/en/tutorials/modular-crm/images/abp-studio-install-module-dialog-for-ordering-v2.png 57.43 KB 42.97 KB -25.2% View diff
docs/en/tutorials/modular-crm/images/visual-studio-order-event-handler-v2.png 8.22 KB 5.28 KB -35.7% View diff

2918 images did not require optimisation.

@hikalkan hikalkan merged commit 322a923 into rel-9.2 Jun 22, 2025
3 checks passed
@hikalkan hikalkan deleted the EngincanV/update-modular-monolith-tutorial branch June 22, 2025 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants