From aa61c928c8c7fa65ca0c4ca846c93c13920d1faa Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Mon, 12 Aug 2024 14:36:56 +0300 Subject: [PATCH 01/21] Add overview docs for sub-items --- docs/en/docs-nav.json | 107 +++++++++++++++++++++++++++++------------- 1 file changed, 74 insertions(+), 33 deletions(-) diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index 6434679793..7bdcfa6b8d 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -2,8 +2,11 @@ "items": [ { "text": "Get started", - "path": "get-started", "items": [ + { + "text": "Overview", + "path": "get-started/index.md" + }, { "text": "Single-layer solution", "path": "get-started/single-layer-web-application.md" @@ -44,8 +47,11 @@ "items": [ { "text": "TODO application", - "path": "tutorials/todo", "items": [ + { + "text": "Overview", + "path": "tutorials/todo/index.md" + }, { "text": "Single-layer solution", "path": "tutorials/todo/single-layer" @@ -116,8 +122,11 @@ "items": [ { "text": "ABP CLI", - "path": "cli", "items": [ + { + "text": "Overview", + "path": "cli/index.md" + }, { "text": "Examples for the new command", "path": "cli/new-command-samples.md" @@ -126,7 +135,6 @@ }, { "text": "ABP Studio", - "path": "studio", "items": [ { "text": "Installation", @@ -171,7 +179,7 @@ "text": "ABP Suite", "items": [ { - "text": "Overall", + "text": "Overview", "path": "suite" }, { @@ -192,8 +200,11 @@ }, { "text": "Generating CRUD Page", - "path": "suite/generating-crud-page.md", "items": [ + { + "text": "Overview", + "path": "suite/generating-crud-page.md" + }, { "text": "Creating Many-To-Many Relationship", "path": "suite/creating-many-to-many-relationship.md" @@ -248,8 +259,11 @@ }, { "text": "Authorization", - "path": "framework/fundamentals/authorization.md", "items": [ + { + "text": "Overview", + "path": "framework/fundamentals/authorization.md" + }, { "text": "Dynamic Claims", "path": "framework/fundamentals/dynamic-claims.md" @@ -258,8 +272,11 @@ }, { "text": "Caching", - "path": "framework/fundamentals/caching.md", "items": [ + { + "text": "Overview", + "path": "framework/fundamentals/caching.md" + }, { "text": "Redis Cache", "path": "framework/fundamentals/redis-cache.md" @@ -276,8 +293,11 @@ }, { "text": "Dependency Injection", - "path": "framework/fundamentals/dependency-injection.md", "items": [ + { + "text": "Overview", + "path": "framework/fundamentals/dependency-injection.md" + }, { "text": "AutoFac Integration", "path": "framework/fundamentals/autofac-integration.md" @@ -306,8 +326,11 @@ }, { "text": "Validation", - "path": "framework/fundamentals/validation.md", "items": [ + { + "text": "Overview", + "path": "framework/fundamentals/validation.md" + }, { "text": "FluentValidation Integration", "path": "framework/fundamentals/fluent-validation.md" @@ -446,7 +469,7 @@ "text": "Event Bus", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/infrastructure/event-bus" }, { @@ -543,13 +566,16 @@ }, { "text": "Architecture", - "path": "framework/architecture", "items": [ + { + "text": "Overview", + "path": "framework/architecture" + }, { "text": "Best Practices", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/architecture/best-practices" }, { @@ -616,7 +642,7 @@ "text": "Customizing/Extending Modules", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/architecture/modularity/extending/customizing-application-modules-guide.md" }, { @@ -639,7 +665,7 @@ "text": "Domain Driven Design", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/architecture/domain-driven-design" }, { @@ -749,7 +775,7 @@ "text": "MVC / Razor Pages", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/mvc-razor-pages/overall.md" }, { @@ -794,8 +820,11 @@ }, { "text": "Tag Helpers", - "path": "framework/ui/mvc-razor-pages/tag-helpers", "items": [ + { + "text": "Overview", + "path": "framework/ui/mvc-razor-pages/tag-helpers" + }, { "text": "Form Elements", "path": "framework/ui/mvc-razor-pages/tag-helpers/form-elements.md" @@ -832,8 +861,11 @@ }, { "text": "Theming", - "path": "framework/ui/mvc-razor-pages/theming.md", "items": [ + { + "text": "Overview", + "path": "framework/ui/mvc-razor-pages/theming.md" + }, { "text": "The Basic Theme", "path": "framework/ui/mvc-razor-pages/basic-theme.md" @@ -848,7 +880,7 @@ "text": "JavaScript API", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/mvc-razor-pages/javascript-api" }, { @@ -909,7 +941,7 @@ "text": "Customize/Extend the UI", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/mvc-razor-pages/customization-user-interface.md" }, { @@ -941,7 +973,7 @@ "text": "Blazor", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/blazor/overall.md" }, { @@ -960,7 +992,7 @@ "text": "Theming", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/blazor/theming.md" }, { @@ -1272,7 +1304,7 @@ "text": "Theming", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/angular/theming.md" }, { @@ -1305,7 +1337,7 @@ "text": "Extensions", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/angular/extensions-overall.md" }, { @@ -1355,7 +1387,7 @@ "text": "React Native", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/react-native" } ] @@ -1364,7 +1396,7 @@ "text": "MAUI", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/ui/maui" } ] @@ -1393,7 +1425,7 @@ "text": "Data Access", "items": [ { - "text": "Overall", + "text": "Overview", "path": "framework/data" }, { @@ -1467,7 +1499,7 @@ "text": "Solution Templates", "items": [ { - "text": "Overall", + "text": "Overview", "path": "solution-templates" }, { @@ -1492,7 +1524,7 @@ "text": "Application Modules", "items": [ { - "text": "Overall", + "text": "Overview", "path": "modules" }, { @@ -1557,8 +1589,11 @@ }, { "text": "IdentityServer", - "path": "modules/identity-server.md", "items": [ + { + "text": "Overview", + "path": "modules/identity-server.md" + }, { "text": "IdentityServer Migration Guide", "path": "release-info/migration-guides/identityserver4-step-by-step.md" @@ -1575,8 +1610,11 @@ }, { "text": "OpenIddict", - "path": "modules/openiddict.md", "items": [ + { + "text": "Overview", + "path": "modules/openiddict.md" + }, { "text": "OpenIddict Migration Guide", "path": "release-info/migration-guides/openiddict-step-by-step.md" @@ -1647,7 +1685,7 @@ "text": "Testing", "items": [ { - "text": "Overall", + "text": "Overview", "path": "testing/overall.md" }, { @@ -1666,8 +1704,11 @@ }, { "text": "Deployment", - "path": "deployment", "items": [ + { + "text": "Overview", + "path": "deployment" + }, { "text": "Configuring SSL certificate(HTTPS)", "path": "deployment/ssl.md" From af113063f81c878e2baf9f6ee3c8b04b5e4e8fb4 Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Mon, 12 Aug 2024 16:00:54 +0300 Subject: [PATCH 02/21] Add missing overview docs to sub-menu items. --- docs/en/docs-nav.json | 107 ++++++++++++++++-- docs/en/framework/api-development/overview.md | 9 ++ .../api-development/standard-apis/overview.md | 4 + .../application-layer-overview.md | 4 + .../best-practices/data-access-overview.md | 4 + .../best-practices/domain-layer-overview.md | 5 + .../domain-driven-design/application-layer.md | 5 + .../domain-driven-design/domain-layer.md | 7 ++ docs/en/framework/fundamentals/overview.md | 14 +++ docs/en/framework/infrastructure/overview.md | 29 +++++ docs/en/framework/ui/angular/overview.md | 3 + docs/en/framework/ui/overview.md | 7 ++ docs/en/release-info/overview.md | 3 + docs/en/tools.md | 7 ++ docs/en/tutorials/overview.md | 3 + 15 files changed, 199 insertions(+), 12 deletions(-) create mode 100644 docs/en/framework/api-development/overview.md create mode 100644 docs/en/framework/api-development/standard-apis/overview.md create mode 100644 docs/en/framework/architecture/best-practices/application-layer-overview.md create mode 100644 docs/en/framework/architecture/best-practices/data-access-overview.md create mode 100644 docs/en/framework/architecture/best-practices/domain-layer-overview.md create mode 100644 docs/en/framework/architecture/domain-driven-design/application-layer.md create mode 100644 docs/en/framework/architecture/domain-driven-design/domain-layer.md create mode 100644 docs/en/framework/fundamentals/overview.md create mode 100644 docs/en/framework/infrastructure/overview.md create mode 100644 docs/en/framework/ui/angular/overview.md create mode 100644 docs/en/framework/ui/overview.md create mode 100644 docs/en/release-info/overview.md create mode 100644 docs/en/tools.md create mode 100644 docs/en/tutorials/overview.md diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index 7bdcfa6b8d..74d0d04417 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -45,6 +45,10 @@ { "text": "Tutorials", "items": [ + { + "text": "Overview", + "path": "tutorials/overview.md" + }, { "text": "TODO application", "items": [ @@ -120,6 +124,10 @@ { "text": "Tools", "items": [ + { + "text": "Overview", + "path": "tools.md" + }, { "text": "ABP CLI", "items": [ @@ -137,16 +145,20 @@ "text": "ABP Studio", "items": [ { - "text": "Installation", - "path": "studio/installation.md" + "text": "Overview", + "path": "studio/index.md" }, { - "text": "Overview", - "path": "studio/overview.md" + "text": "Installation", + "path": "studio/installation.md" }, { "text": "Fundamentals", "items": [ + { + "text": "Overview", + "path": "studio/overview.md" + }, { "text": "Solution Explorer", "path": "studio/solution-explorer.md" @@ -253,6 +265,10 @@ { "text": "Fundamentals", "items": [ + { + "text": "Overview", + "path": "framework/fundamentals/overview.md" + }, { "text": "Application Startup", "path": "framework/fundamentals/application-startup.md" @@ -342,14 +358,21 @@ { "text": "Infrastructure", "items": [ + { + "text": "Overview", + "path": "framework/infrastructure/overview.md" + }, { "text": "Audit Logging", "path": "framework/infrastructure/audit-logging.md" }, { "text": "Background Jobs", - "path": "framework/infrastructure/background-jobs", "items": [ + { + "text": "Overview", + "path": "framework/infrastructure/background-jobs" + }, { "text": "Hangfire Integration", "path": "framework/infrastructure/background-jobs/hangfire.md" @@ -366,8 +389,11 @@ }, { "text": "Background Workers", - "path": "framework/infrastructure/background-workers", "items": [ + { + "text": "Overview", + "path": "framework/infrastructure/background-workers" + }, { "text": "Quartz Integration", "path": "framework/infrastructure/background-workers/quartz.md" @@ -382,7 +408,7 @@ "text": "BLOB Storing", "items": [ { - "text": "BLOB Storing System", + "text": "Overview", "path": "framework/infrastructure/blob-storing" }, { @@ -452,7 +478,7 @@ "text": "Email Sending", "items": [ { - "text": "Email Sending System", + "text": "Overview", "path": "framework/infrastructure/emailing.md" }, { @@ -478,8 +504,11 @@ }, { "text": "Distributed Event Bus", - "path": "framework/infrastructure/event-bus/distributed", "items": [ + { + "text": "Overview", + "path": "framework/infrastructure/event-bus/distributed" + }, { "text": "Azure Service Bus Integration", "path": "framework/infrastructure/event-bus/distributed/azure.md" @@ -542,8 +571,11 @@ }, { "text": "Text Templating", - "path": "framework/infrastructure/text-templating", "items": [ + { + "text": "Overview", + "path": "framework/infrastructure/text-templating" + }, { "text": "Razor Integration", "path": "framework/infrastructure/text-templating/razor.md" @@ -585,6 +617,10 @@ { "text": "Domain Layer", "items": [ + { + "text": "Overview", + "path": "framework/architecture/best-practices/domain-layer-overview.md" + }, { "text": "Entities", "path": "framework/architecture/best-practices/entities.md" @@ -602,6 +638,10 @@ { "text": "Application Layer", "items": [ + { + "text": "Overview", + "path": "framework/architecture/best-practices/application-layer-overview.md" + }, { "text": "Application Services", "path": "framework/architecture/best-practices/application-services.md" @@ -615,6 +655,10 @@ { "text": "Data Access", "items": [ + { + "text": "Overview", + "path": "framework/architecture/best-practices/data-access-overview.md" + }, { "text": "Entity Framework Core Integration", "path": "framework/architecture/best-practices/entity-framework-core-integration.md" @@ -631,7 +675,7 @@ "text": "Modularity", "items": [ { - "text": "Basics", + "text": "Overview", "path": "framework/architecture/modularity/basics.md" }, { @@ -671,6 +715,10 @@ { "text": "Domain Layer", "items": [ + { + "text": "Overview", + "path": "framework/architecture/domain-driven-design/domain-layer.md" + }, { "text": "Entities & Aggregate Roots", "path": "framework/architecture/domain-driven-design/entities.md" @@ -696,6 +744,10 @@ { "text": "Application Layer", "items": [ + { + "text": "Overview", + "path": "framework/architecture/domain-driven-design/application-layer.md" + }, { "text": "Application Services", "path": "framework/architecture/domain-driven-design/application-services.md" @@ -729,9 +781,17 @@ { "text": "API Development", "items": [ + { + "text": "Overview", + "path": "framework/api-development/overview.md" + }, { "text": "ABP Endpoints", "items": [ + { + "text": "Overview", + "path": "framework/api-development/standard-apis/overview.md" + }, { "text": "Application Configuration", "path": "framework/api-development/standard-apis/configuration.md" @@ -771,6 +831,10 @@ { "text": "User Interface", "items": [ + { + "text": "Overview", + "path": "framework/ui/overview.md" + }, { "text": "MVC / Razor Pages", "items": [ @@ -1113,6 +1177,10 @@ { "text": "Angular", "items": [ + { + "text": "Overview", + "path": "framework/ui/angular/overview.md" + }, { "text": "Quick Start", "path": "framework/ui/angular/quick-start.md" @@ -1430,8 +1498,11 @@ }, { "text": "Entity Framework Core", - "path": "framework/data/entity-framework-core", "items": [ + { + "text": "Overview", + "path": "framework/data/entity-framework-core" + }, { "text": "Database Migrations", "path": "framework/data/entity-framework-core/migrations.md" @@ -1671,6 +1742,10 @@ { "text": "UI Themes", "items": [ + { + "text": "Overview", + "path": "ui-themes/index.md" + }, { "text": "The Basic Theme", "path": "framework/ui/mvc-razor-pages/basic-theme.md" @@ -1759,6 +1834,10 @@ { "text": "Books", "items": [ + { + "text": "Overview", + "path": "https://abp.io/books" + }, { "text": "Mastering ABP Framework", "path": "https://abp.io/books/mastering-abp-framework" @@ -1772,6 +1851,10 @@ { "text": "Release Information", "items": [ + { + "text": "Overview", + "path": "release-info/overview.md" + }, { "text": "Release Notes", "path": "release-info/release-notes.md" diff --git a/docs/en/framework/api-development/overview.md b/docs/en/framework/api-development/overview.md new file mode 100644 index 0000000000..d39e5c8199 --- /dev/null +++ b/docs/en/framework/api-development/overview.md @@ -0,0 +1,9 @@ +## API Development + +* [ABP Endpoints](./standard-apis/overview.md) +* [API Versioning](./versioning.md) +* [Auto API Controllers](./auto-controllers.md) +* [Dynamic C# API Clients](./dynamic-csharp-clients.md) +* [Integration Services](./integration-services.md) +* [Static C# API Clients](./static-csharp-clients.md) +* [Swagger Integration](./swagger.md) \ No newline at end of file diff --git a/docs/en/framework/api-development/standard-apis/overview.md b/docs/en/framework/api-development/standard-apis/overview.md new file mode 100644 index 0000000000..3a878e1c2c --- /dev/null +++ b/docs/en/framework/api-development/standard-apis/overview.md @@ -0,0 +1,4 @@ +## ABP Endpoints + +* [Application Configuration](./configuration.md) +* [Application Localization](./localization.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/application-layer-overview.md b/docs/en/framework/architecture/best-practices/application-layer-overview.md new file mode 100644 index 0000000000..1a37df91fa --- /dev/null +++ b/docs/en/framework/architecture/best-practices/application-layer-overview.md @@ -0,0 +1,4 @@ +## Best Practices: Application Layer + +* [Application Services](./application-services.md) +* [Data Transfer Objects](./data-transfer-objects.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/data-access-overview.md b/docs/en/framework/architecture/best-practices/data-access-overview.md new file mode 100644 index 0000000000..ed3422cb5a --- /dev/null +++ b/docs/en/framework/architecture/best-practices/data-access-overview.md @@ -0,0 +1,4 @@ +## Best Practices: Data Access + +* [Entity Framework Core](./entity-framework-core-integration.md) +* [MongoDB](./mongodb-integration.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/domain-layer-overview.md b/docs/en/framework/architecture/best-practices/domain-layer-overview.md new file mode 100644 index 0000000000..94f31cc264 --- /dev/null +++ b/docs/en/framework/architecture/best-practices/domain-layer-overview.md @@ -0,0 +1,5 @@ +## Best Practices: Domain Layer + +* [Entities](./entities.md) +* [Repositories](./repositories.md) +* [Domain Services](./domain-services.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/domain-driven-design/application-layer.md b/docs/en/framework/architecture/domain-driven-design/application-layer.md new file mode 100644 index 0000000000..5da529c803 --- /dev/null +++ b/docs/en/framework/architecture/domain-driven-design/application-layer.md @@ -0,0 +1,5 @@ +## Domain Driven Design: Application Layer + +* [Application Services](./application-services.md) +* [Data Transfer Objects](./data-transfer-objects.md) +* [Unit of Work](./unit-of-work.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/domain-driven-design/domain-layer.md b/docs/en/framework/architecture/domain-driven-design/domain-layer.md new file mode 100644 index 0000000000..f0a11e7d8f --- /dev/null +++ b/docs/en/framework/architecture/domain-driven-design/domain-layer.md @@ -0,0 +1,7 @@ +## Domain Driven Design: Domain Layer + +* [Entities & Aggregate Roots](./entities.md) +* [Value Objects](./value-objects.md) +* [Repositories](./repositories.md) +* [Domain Services](./domain-services.md) +* [Specifications](./specifications.md) \ No newline at end of file diff --git a/docs/en/framework/fundamentals/overview.md b/docs/en/framework/fundamentals/overview.md new file mode 100644 index 0000000000..74db71d3c6 --- /dev/null +++ b/docs/en/framework/fundamentals/overview.md @@ -0,0 +1,14 @@ +## ABP Fundamentals: Overview + +* [Application Startup](./application-startup.md) +* [Authorization](./authorization.md) +* [Caching](./caching.md) +* [Configuration](./configuration.md) +* [Connection Strings](./connection-strings.md) +* [Dependency Injection](./dependency-injection.md) +* [Exception Handling](./exception-handling.md) +* [Localization](./localization.md) +* [Logging](./logging.md) +* [Object Extensions](./object-extensions.md) +* [Options](./options.md) +* [Validation](./validation.md) \ No newline at end of file diff --git a/docs/en/framework/infrastructure/overview.md b/docs/en/framework/infrastructure/overview.md new file mode 100644 index 0000000000..358dff66f7 --- /dev/null +++ b/docs/en/framework/infrastructure/overview.md @@ -0,0 +1,29 @@ +## ABP Infrastructure: Overview + +* [Audit Logging](./audit-logging.md) +* [Background Jobs](./background-jobs/index.md) +* [Background Workers](./background-workers/index.md) +* [BLOB Storing](./blob-storing/index.md) +* [Cancellation Token Provider](./cancellation-token-provider.md) +* [CSRF/XSRF & Anti Forgery](./csrf-anti-forgery.md) +* [Concurrency Check](./concurrency-check.md) +* [Current User](./current-user.md) +* [Data Filtering](./data-filtering.md) +* [Data Seeding](./data-seeding.md) +* [Distributing Locking](./distributed-locking.md) +* [Email Sending](./emailing.md) +* [Entity Cache](./entity-cache.md) +* [Event Bus](./event-bus/index.md) +* [Features](./features.md) +* [Global Features](./global-features.md) +* [GUID Generation](./guid-generation.md) +* [Image Manipulation](./image-manipulation.md) +* [JSON](./json.md) +* [Object to Object Mapping](./object-to-object-mapping.md) +* [Settings](./settings.md) +* [Simple State Checker](./simple-state-checker.md) +* [SMS Sending](./sms-sending.md) +* [String Encryption](./string-encryption.md) +* [Text Templating](./text-templating/index.md) +* [Timing](./timing.md) +* [Virtual File System](./virtual-file-system.md) \ No newline at end of file diff --git a/docs/en/framework/ui/angular/overview.md b/docs/en/framework/ui/angular/overview.md new file mode 100644 index 0000000000..fe9d290cb5 --- /dev/null +++ b/docs/en/framework/ui/angular/overview.md @@ -0,0 +1,3 @@ +## Angular UI: Overview + +//TODO:... \ No newline at end of file diff --git a/docs/en/framework/ui/overview.md b/docs/en/framework/ui/overview.md new file mode 100644 index 0000000000..123d158754 --- /dev/null +++ b/docs/en/framework/ui/overview.md @@ -0,0 +1,7 @@ +## ABP: UI Options + +* [MVC / Razor Pages](./mvc-razor-pages/overall.md) +* [Blazor](./blazor/overall.md) +* [Angular](./angular/overview.md) +* [React Native](./react-native/index.md) +* [MAUI](./maui/index.md) \ No newline at end of file diff --git a/docs/en/release-info/overview.md b/docs/en/release-info/overview.md new file mode 100644 index 0000000000..fc89a7c636 --- /dev/null +++ b/docs/en/release-info/overview.md @@ -0,0 +1,3 @@ +## Release Information: Overview + +//TODO:... \ No newline at end of file diff --git a/docs/en/tools.md b/docs/en/tools.md new file mode 100644 index 0000000000..aa7d048d95 --- /dev/null +++ b/docs/en/tools.md @@ -0,0 +1,7 @@ +## Tools + +ABP provides a comprehensive set of tools designed to enhance the development experience and improve productivity: + +* [ABP CLI](./cli/index.md): Command line tool to perform some common operations for ABP based solutions. +* [ABP Suite](./suite/index.md): A complementary tool that allows you to build web pages in a matter of minutes. +* [ABP Studio](./studio/index.md): **Cross-platform** desktop application for ABP and .NET developers. Aims to provide a comfortable development environment for you by automating things, providing insights about your solution, making develop, run, browse, monitor, trace and deploy your solutions much easier. \ No newline at end of file diff --git a/docs/en/tutorials/overview.md b/docs/en/tutorials/overview.md new file mode 100644 index 0000000000..8a1c67b5e3 --- /dev/null +++ b/docs/en/tutorials/overview.md @@ -0,0 +1,3 @@ +## ABP Tutorials: Overview + +//TODO:... \ No newline at end of file From ef870c35f37349db442fea991579fff6f9f396f3 Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Mon, 12 Aug 2024 16:42:01 +0300 Subject: [PATCH 03/21] Update all new overview docs. --- docs/en/docs-nav.json | 4 ---- docs/en/framework/api-development/overview.md | 4 +++- .../framework/api-development/standard-apis/overview.md | 2 ++ .../best-practices/application-layer-overview.md | 2 ++ .../architecture/best-practices/data-access-overview.md | 2 ++ .../architecture/best-practices/domain-layer-overview.md | 2 ++ .../domain-driven-design/application-layer.md | 2 ++ .../architecture/domain-driven-design/domain-layer.md | 2 ++ docs/en/framework/fundamentals/overview.md | 2 ++ docs/en/framework/infrastructure/overview.md | 2 ++ docs/en/framework/ui/angular/overview.md | 3 --- docs/en/framework/ui/overview.md | 4 +++- docs/en/release-info/overview.md | 8 +++++++- docs/en/tutorials/overview.md | 5 ++++- 14 files changed, 33 insertions(+), 11 deletions(-) delete mode 100644 docs/en/framework/ui/angular/overview.md diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index 74d0d04417..caabea99cb 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -1177,10 +1177,6 @@ { "text": "Angular", "items": [ - { - "text": "Overview", - "path": "framework/ui/angular/overview.md" - }, { "text": "Quick Start", "path": "framework/ui/angular/quick-start.md" diff --git a/docs/en/framework/api-development/overview.md b/docs/en/framework/api-development/overview.md index d39e5c8199..9d7e215896 100644 --- a/docs/en/framework/api-development/overview.md +++ b/docs/en/framework/api-development/overview.md @@ -1,4 +1,6 @@ -## API Development +## API Development: Overview + +ABP provides a set of features and integrations to third-party libraries to easily develop APIs. Here, is the list of documents that you can refer to while developing APIs: * [ABP Endpoints](./standard-apis/overview.md) * [API Versioning](./versioning.md) diff --git a/docs/en/framework/api-development/standard-apis/overview.md b/docs/en/framework/api-development/standard-apis/overview.md index 3a878e1c2c..7dc0666bdd 100644 --- a/docs/en/framework/api-development/standard-apis/overview.md +++ b/docs/en/framework/api-development/standard-apis/overview.md @@ -1,4 +1,6 @@ ## ABP Endpoints +ABP provides pre-built and standart endpoints that contains some useful information about the application/service, such as localization entries and settings. Here, is the list of some pre-built endpoints: + * [Application Configuration](./configuration.md) * [Application Localization](./localization.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/application-layer-overview.md b/docs/en/framework/architecture/best-practices/application-layer-overview.md index 1a37df91fa..b7650d6699 100644 --- a/docs/en/framework/architecture/best-practices/application-layer-overview.md +++ b/docs/en/framework/architecture/best-practices/application-layer-overview.md @@ -1,4 +1,6 @@ ## Best Practices: Application Layer +ABP suggests some best-practices that you can use while implementing the Application Layer by following Domain Driven Design principles: + * [Application Services](./application-services.md) * [Data Transfer Objects](./data-transfer-objects.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/data-access-overview.md b/docs/en/framework/architecture/best-practices/data-access-overview.md index ed3422cb5a..3c0aa1a9c7 100644 --- a/docs/en/framework/architecture/best-practices/data-access-overview.md +++ b/docs/en/framework/architecture/best-practices/data-access-overview.md @@ -1,4 +1,6 @@ ## Best Practices: Data Access +ABP suggests some best-practices that you can use while implementing the Infrastructure Layer (integrations) by following Domain Driven Design principles: + * [Entity Framework Core](./entity-framework-core-integration.md) * [MongoDB](./mongodb-integration.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/domain-layer-overview.md b/docs/en/framework/architecture/best-practices/domain-layer-overview.md index 94f31cc264..995d545cb5 100644 --- a/docs/en/framework/architecture/best-practices/domain-layer-overview.md +++ b/docs/en/framework/architecture/best-practices/domain-layer-overview.md @@ -1,5 +1,7 @@ ## Best Practices: Domain Layer +ABP suggests some best-practices that you can use while implementing the Domain Layer by following Domain Driven Design principles: + * [Entities](./entities.md) * [Repositories](./repositories.md) * [Domain Services](./domain-services.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/domain-driven-design/application-layer.md b/docs/en/framework/architecture/domain-driven-design/application-layer.md index 5da529c803..03b83fb038 100644 --- a/docs/en/framework/architecture/domain-driven-design/application-layer.md +++ b/docs/en/framework/architecture/domain-driven-design/application-layer.md @@ -1,5 +1,7 @@ ## Domain Driven Design: Application Layer +Application Layer mediates between the Presentation and Domain Layers. Orchestrates business objects to perform specific application tasks and implements use cases as the application logic. Here, is the list of the building blocks of the Application Layer: + * [Application Services](./application-services.md) * [Data Transfer Objects](./data-transfer-objects.md) * [Unit of Work](./unit-of-work.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/domain-driven-design/domain-layer.md b/docs/en/framework/architecture/domain-driven-design/domain-layer.md index f0a11e7d8f..9ce7519810 100644 --- a/docs/en/framework/architecture/domain-driven-design/domain-layer.md +++ b/docs/en/framework/architecture/domain-driven-design/domain-layer.md @@ -1,5 +1,7 @@ ## Domain Driven Design: Domain Layer +Domain Layer contains business objects and the core (domain) business rules of the application and it's the heart of the application. Here, is the list of building blocks of the Domain Layer: + * [Entities & Aggregate Roots](./entities.md) * [Value Objects](./value-objects.md) * [Repositories](./repositories.md) diff --git a/docs/en/framework/fundamentals/overview.md b/docs/en/framework/fundamentals/overview.md index 74db71d3c6..b09e8c5d5a 100644 --- a/docs/en/framework/fundamentals/overview.md +++ b/docs/en/framework/fundamentals/overview.md @@ -1,5 +1,7 @@ ## ABP Fundamentals: Overview +ABP provides fundamental documents that explain to you the core building-blocks of ABP & .NET applications. Here, is the full list of the fundamental documents: + * [Application Startup](./application-startup.md) * [Authorization](./authorization.md) * [Caching](./caching.md) diff --git a/docs/en/framework/infrastructure/overview.md b/docs/en/framework/infrastructure/overview.md index 358dff66f7..df52f222db 100644 --- a/docs/en/framework/infrastructure/overview.md +++ b/docs/en/framework/infrastructure/overview.md @@ -1,5 +1,7 @@ ## ABP Infrastructure: Overview +ABP provides a complete infrastructure for creating software solutions with modern architectures based on .NET platform: + * [Audit Logging](./audit-logging.md) * [Background Jobs](./background-jobs/index.md) * [Background Workers](./background-workers/index.md) diff --git a/docs/en/framework/ui/angular/overview.md b/docs/en/framework/ui/angular/overview.md deleted file mode 100644 index fe9d290cb5..0000000000 --- a/docs/en/framework/ui/angular/overview.md +++ /dev/null @@ -1,3 +0,0 @@ -## Angular UI: Overview - -//TODO:... \ No newline at end of file diff --git a/docs/en/framework/ui/overview.md b/docs/en/framework/ui/overview.md index 123d158754..8ae4cd5b0e 100644 --- a/docs/en/framework/ui/overview.md +++ b/docs/en/framework/ui/overview.md @@ -1,7 +1,9 @@ ## ABP: UI Options +ABP provides several options for building the user interface (UI) in your applications. Here are some of the officially supported UI options you can use with ABP: + * [MVC / Razor Pages](./mvc-razor-pages/overall.md) * [Blazor](./blazor/overall.md) -* [Angular](./angular/overview.md) +* [Angular](./angular/quick-start.md) * [React Native](./react-native/index.md) * [MAUI](./maui/index.md) \ No newline at end of file diff --git a/docs/en/release-info/overview.md b/docs/en/release-info/overview.md index fc89a7c636..3a2d4704d6 100644 --- a/docs/en/release-info/overview.md +++ b/docs/en/release-info/overview.md @@ -1,3 +1,9 @@ ## Release Information: Overview -//TODO:... \ No newline at end of file +* [Release Notes](./release-notes.md) +* [Migration Guides](./migration-guides/index.md) +* [Road Map](./road-map.md) +* [Upgrading](./upgrading.md) +* [Preview Releases](./previews.md) +* [Nightly Releases](./nightly-builds.md) +* [Official Packages](https://abp.io/packages) \ No newline at end of file diff --git a/docs/en/tutorials/overview.md b/docs/en/tutorials/overview.md index 8a1c67b5e3..357649f5b3 100644 --- a/docs/en/tutorials/overview.md +++ b/docs/en/tutorials/overview.md @@ -1,3 +1,6 @@ ## ABP Tutorials: Overview -//TODO:... \ No newline at end of file +This document provides an overview of essential tutorials that will help you get started with ABP platform: + +* [TODO Application](todo/index.md): This is a single-part, quick-start tutorial to build a simple application with ABP. Start with this tutorial if you want to quickly understand how ABP works. +* [Book Store Application](book-store/overview.md): This is a multi-part, complete tutorial to build a bookstore application with ABP. Start with this tutorial if you want to create a layered solution with ABP and apply DDD best practices. \ No newline at end of file From 30f5ae931901711ebb614bf4136dcf53faecc6af Mon Sep 17 00:00:00 2001 From: sumeyyeKurtulus Date: Tue, 13 Aug 2024 16:36:01 +0300 Subject: [PATCH 04/21] update: toastr styles --- .../lib/components/toast/toast.component.html | 4 ++-- .../lib/components/toast/toast.component.scss | 20 +++++++++++-------- .../lib/components/toast/toast.component.ts | 12 +++++------ 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.html b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.html index 0f123fdadd..74e4f72a0a 100644 --- a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.html +++ b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.html @@ -1,11 +1,11 @@
- +
@if (toast.options?.closable) { }
diff --git a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss index b4966c310d..1b4c9eb5e7 100644 --- a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss +++ b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss @@ -14,35 +14,39 @@ $toastClass: abp-toast; .#{$toastClass} { display: grid; - grid-template-columns: 50px 1fr; + grid-template-columns: 35px 1fr; gap: 10px; margin: 5px 0; - padding: 10px; - border-radius: 0px; + padding: 7px; width: 350px; user-select: none; box-shadow: 0 0 10px -5px rgba(#000, 0.4); z-index: 9999; + color: #fff; + border-radius: 8px; + font-size: 14px; + box-shadow: 0 0 20px 0 rgba(76, 87, 125, 0.02); + @include fillColor(#f0f0f0, #000); opacity: 1; &.#{$toastClass}-success { - @include fillColor(#51a351, #fff); + @include fillColor(#4fbf67, #fff); } &.#{$toastClass}-info { - @include fillColor(#2f96b4, #fff); + @include fillColor(#438aa7, #fff); } &.#{$toastClass}-warning { - @include fillColor(#f89406, #fff); + @include fillColor(#ff9f38, #fff); } &.#{$toastClass}-error { - @include fillColor(#bd362f, #fff); + @include fillColor(#c00d49, #fff); } .#{$toastClass}-icon { display: flex; align-items: center; justify-content: center; .icon { - font-size: 36px; + font-size: 32px; } } .#{$toastClass}-content { diff --git a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.ts b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.ts index 4d842df02a..b528d490a4 100644 --- a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.ts +++ b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.ts @@ -18,22 +18,22 @@ export class ToastComponent implements OnInit { get iconClass(): string { const { iconClass } = this.toast.options || {}; - + if (iconClass) { return iconClass; } switch (this.toast.severity) { case 'success': - return 'fa-check-circle'; + return 'bi-check'; case 'info': - return 'fa-info-circle'; + return 'bi-info-circle'; case 'warning': - return 'fa-exclamation-triangle'; + return 'bi-exclamation-triangle'; case 'error': - return 'fa-times-circle'; + return 'bi-shield-exclamation'; default: - return 'fa-exclamation-circle'; + return 'bi-exclamation-triangle'; } } From 24df181ccf9acb8386ab0e4f3b3d0f6e40c1879e Mon Sep 17 00:00:00 2001 From: sumeyyeKurtulus Date: Thu, 15 Aug 2024 15:26:45 +0300 Subject: [PATCH 05/21] update: the Node, Yarn and Npm versions for Angular v18 upgrade --- docs/en/framework/ui/angular/quick-start.md | 4 ++-- docs/en/get-started/layered-web-application.md | 4 ++-- docs/en/get-started/single-layer-web-application.md | 4 ++-- docs/en/release-info/migration-guides/abp-8-3.md | 4 ++++ docs/en/studio/installation.md | 2 +- docs/en/tutorials/todo/layered/index.md | 2 +- docs/en/tutorials/todo/single-layer/index.md | 2 +- 7 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/en/framework/ui/angular/quick-start.md b/docs/en/framework/ui/angular/quick-start.md index 2a8986f965..df2d6331b9 100644 --- a/docs/en/framework/ui/angular/quick-start.md +++ b/docs/en/framework/ui/angular/quick-start.md @@ -4,8 +4,8 @@ Please follow the steps below to prepare your development environment for Angular. -1. **Install Node.js:** Please visit [Node.js downloads page](https://nodejs.org/en/download/) and download proper Node.js v16 or v18 installer for your OS. An alternative is to install [NVM](https://github.com/nvm-sh/nvm) and use it to have multiple versions of Node.js in your operating system. -2. **[Optional] Install Yarn:** You may install Yarn v1 (not v2) following the instructions on [the installation page](https://classic.yarnpkg.com/en/docs/install). Yarn v1 delivers an arguably better developer experience compared to npm v6 and below. You may skip this step and work with npm, which is built-in in Node.js, instead. +1. **Install Node.js:** Please visit [Node.js downloads page](https://nodejs.org/en/download/) and download proper Node.js `v18.19+` installer for your OS. An alternative is to install [NVM](https://github.com/nvm-sh/nvm) and use it to have multiple versions of Node.js in your operating system. +2. **[Optional] Install Yarn:** You may install Yarn v1.22+ (not v2) following the instructions on [the installation page](https://classic.yarnpkg.com/en/docs/install). Yarn v1 delivers an arguably better developer experience compared to npm v10 and below. You may skip this step and work with npm, which is built-in in Node.js, instead. 3. **[Optional] Install VS Code:** [VS Code](https://code.visualstudio.com/) is a free, open-source IDE which works seamlessly with TypeScript. Although you can use any IDE including Visual Studio or Rider, VS Code will most likely deliver the best developer experience when it comes to Angular projects. ABP project templates even contain plugin recommendations for VS Code users, which VS Code will ask you to install when you open the Angular project folder. Here is a list of recommended extensions: - [Angular Language Service](https://marketplace.visualstudio.com/items?itemName=angular.ng-template) - [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) diff --git a/docs/en/get-started/layered-web-application.md b/docs/en/get-started/layered-web-application.md index ee26397797..804b2df787 100644 --- a/docs/en/get-started/layered-web-application.md +++ b/docs/en/get-started/layered-web-application.md @@ -22,8 +22,8 @@ The following tools should be installed on your development machine: * [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) (v17.3+) for Windows / [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/). [1](#f-editor) * [.NET 8.0+](https://dotnet.microsoft.com/en-us/download/dotnet) {{ if UI != "Blazor" }} -* [Node v16 or v18](https://nodejs.org/) -* [Yarn v1.20+ (not v2)](https://classic.yarnpkg.com/en/docs/install) [2](#f-yarn) or npm v6+ (already installed with Node) +* [Node v18.19+](https://nodejs.org/) +* [Yarn v1.22+ (not v2)](https://classic.yarnpkg.com/en/docs/install) [2](#f-yarn) or npm v10+ (already installed with Node) {{ end }} {{ if Tiered == "Yes" }} * [Redis](https://redis.io/) (as the [distributed cache](Caching.md)). diff --git a/docs/en/get-started/single-layer-web-application.md b/docs/en/get-started/single-layer-web-application.md index 9708c513cb..201d0fb2df 100644 --- a/docs/en/get-started/single-layer-web-application.md +++ b/docs/en/get-started/single-layer-web-application.md @@ -21,8 +21,8 @@ The following tools should be installed on your development machine: * [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) (v17.3+) for Windows / [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/). [1](#f-editor) * [.NET 8.0+](https://dotnet.microsoft.com/en-us/download/dotnet) {{ if UI != "Blazor" }} -* [Node v16 or v18](https://nodejs.org/) -* [Yarn v1.20+ (not v2)](https://classic.yarnpkg.com/en/docs/install) [2](#f-yarn) or npm v6+ (already installed with Node) +* [Node v18.19+](https://nodejs.org/) +* [Yarn v1.22+ (not v2)](https://classic.yarnpkg.com/en/docs/install) [2](#f-yarn) or npm v10+ (already installed with Node) {{ end }} {{ if Tiered == "Yes" }} * [Redis](https://redis.io/) (as the [distributed cache](Caching.md)). diff --git a/docs/en/release-info/migration-guides/abp-8-3.md b/docs/en/release-info/migration-guides/abp-8-3.md index bc726e68d8..50a7f274a4 100644 --- a/docs/en/release-info/migration-guides/abp-8-3.md +++ b/docs/en/release-info/migration-guides/abp-8-3.md @@ -49,6 +49,10 @@ However, notice this package is used by the `@abp/aspnetcore.mvc.ui.theme.shared See the PR for more info: https://github.com/abpframework/abp/pull/19340 +### Angular UI + +We wish to formally inform you that ABP version 8.3 has been upgraded to incorporate Angular version 18. Consequently, we recommend migrating your application to [Angular v18](https://angular.dev/update-guide) to ensure compatibility. + ## PRO > Please check the **Open-Source (Framework)** section before reading this section. The listed topics might affect your application and you might need to take care of them. diff --git a/docs/en/studio/installation.md b/docs/en/studio/installation.md index 11f390f9f3..4dc158e464 100644 --- a/docs/en/studio/installation.md +++ b/docs/en/studio/installation.md @@ -8,7 +8,7 @@ Before you begin the installation process for ABP Studio, ensure that your system meets the following pre-requirements: ### Node -Make sure [Node.js](https://nodejs.org/en) is installed on your system. If you have not installed Node.js, you can download the `v16` or `v18` version from the official [Node.js website](https://nodejs.org/en/download/prebuilt-installer). +Make sure [Node.js](https://nodejs.org/en) is installed on your system. If you have not installed Node.js, you can download the `v18.19+` version from the official [Node.js website](https://nodejs.org/en/download/prebuilt-installer). ### WireGuard (Optional) ABP Studio needs [WireGuard](https://www.wireguard.com/) for Kubernetes operations. You can find the installation instructions for your specific operating system below: diff --git a/docs/en/tutorials/todo/layered/index.md b/docs/en/tutorials/todo/layered/index.md index db25c826f1..6761bb68bb 100644 --- a/docs/en/tutorials/todo/layered/index.md +++ b/docs/en/tutorials/todo/layered/index.md @@ -53,7 +53,7 @@ This documentation has a video tutorial on **YouTube**!! You can watch it here: ## Pre-Requirements * An IDE (e.g. [Visual Studio](https://visualstudio.microsoft.com/vs/)) that supports [.NET 8.0+](https://dotnet.microsoft.com/download/dotnet) development. -* [Node v16.x](https://nodejs.org/) +* [Node v18.19+](https://nodejs.org/) {{if DB=="Mongo"}} diff --git a/docs/en/tutorials/todo/single-layer/index.md b/docs/en/tutorials/todo/single-layer/index.md index 9afbbd8833..3b4f755c70 100644 --- a/docs/en/tutorials/todo/single-layer/index.md +++ b/docs/en/tutorials/todo/single-layer/index.md @@ -49,7 +49,7 @@ This documentation has a video tutorial on **YouTube**!! You can watch it here: ## Pre-Requirements * An IDE (e.g. [Visual Studio](https://visualstudio.microsoft.com/vs/)) that supports [.NET 8.0+](https://dotnet.microsoft.com/download/dotnet) development. -* [Node v16.x](https://nodejs.org/) +* [Node v18.19+](https://nodejs.org/) {{if DB=="Mongo"}} From 855a2952b2884740ecb1819405c8b3b6d05dab92 Mon Sep 17 00:00:00 2001 From: sumeyyeKurtulus Date: Fri, 16 Aug 2024 10:50:30 +0300 Subject: [PATCH 06/21] add: tiny padding to align with default icon configurations --- .../src/lib/components/toast/toast.component.scss | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss index 1b4c9eb5e7..bc800aebd3 100644 --- a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss +++ b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss @@ -55,6 +55,8 @@ $toastClass: abp-toast; align-self: center; flex-direction: column; word-break: break-word; + padding-bottom: 2px; + .#{$toastClass}-close-button { position: absolute; top: 0; @@ -65,7 +67,7 @@ $toastClass: abp-toast; margin: 0; padding: 0px 5px 0 0; width: 25px; - height: 25px; + height: 100%; border: none; border-radius: 50%; background: transparent; From c97fd2c875b0748f3e995982176c0201af562e8f Mon Sep 17 00:00:00 2001 From: Yunus Emre Kalkan Date: Fri, 16 Aug 2024 13:28:55 +0300 Subject: [PATCH 07/21] Remove Chat from migration doc --- docs/en/guides/migrating-from-open-source.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/en/guides/migrating-from-open-source.md b/docs/en/guides/migrating-from-open-source.md index f0ecbfc22b..f73b7afc8d 100644 --- a/docs/en/guides/migrating-from-open-source.md +++ b/docs/en/guides/migrating-from-open-source.md @@ -38,7 +38,6 @@ And install the following modules to your solution: - Volo.Abp.LanguageManagement - Volo.Abp.TextTemplateManagement - Volo.FileManagement -- Volo.Chat - Volo.Abp.Gdpr - Volo.Abp.LeptonXTheme From e7921db3a448ab7b683f0932f8f7957ef2ec13ce Mon Sep 17 00:00:00 2001 From: liangshiwei Date: Fri, 16 Aug 2024 19:07:38 +0800 Subject: [PATCH 08/21] Add Url to DocumentRenderErrorEvent --- .../Volo/Docs/Documents/DocumentRenderErrorEvent.cs | 2 ++ .../src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/modules/docs/src/Volo.Docs.Domain.Shared/Volo/Docs/Documents/DocumentRenderErrorEvent.cs b/modules/docs/src/Volo.Docs.Domain.Shared/Volo/Docs/Documents/DocumentRenderErrorEvent.cs index 2f30099576..19e7b01227 100644 --- a/modules/docs/src/Volo.Docs.Domain.Shared/Volo/Docs/Documents/DocumentRenderErrorEvent.cs +++ b/modules/docs/src/Volo.Docs.Domain.Shared/Volo/Docs/Documents/DocumentRenderErrorEvent.cs @@ -5,4 +5,6 @@ public class DocumentRenderErrorEvent public string Name { get; set; } public string ErrorMessage { get; set; } + + public string Url { get; set; } } \ No newline at end of file diff --git a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs index c80b81bf71..b3ec299de9 100644 --- a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs +++ b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs @@ -590,7 +590,9 @@ namespace Volo.Docs.Pages.Documents.Project Document.Content = $"````txt{Environment.NewLine}{message}{Environment.NewLine}````"; await LocalEventBus.PublishAsync(new DocumentRenderErrorEvent { - ErrorMessage = message, Name = Document.Name + ErrorMessage = e.Message, + Name = Document.Name, + Url = Request.GetDisplayUrl() }); // Slow down with crawling From ede0da863e6c98b4db88026083cce07c4b0ec02a Mon Sep 17 00:00:00 2001 From: liangshiwei Date: Fri, 16 Aug 2024 20:29:45 +0800 Subject: [PATCH 09/21] Add UserPreferences to DocumentRenderErrorEvent --- .../Volo/Docs/Documents/DocumentRenderErrorEvent.cs | 4 ++++ .../src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/modules/docs/src/Volo.Docs.Domain.Shared/Volo/Docs/Documents/DocumentRenderErrorEvent.cs b/modules/docs/src/Volo.Docs.Domain.Shared/Volo/Docs/Documents/DocumentRenderErrorEvent.cs index 19e7b01227..f837c740e7 100644 --- a/modules/docs/src/Volo.Docs.Domain.Shared/Volo/Docs/Documents/DocumentRenderErrorEvent.cs +++ b/modules/docs/src/Volo.Docs.Domain.Shared/Volo/Docs/Documents/DocumentRenderErrorEvent.cs @@ -1,3 +1,5 @@ +using System.Collections.Generic; + namespace Volo.Docs.Documents; public class DocumentRenderErrorEvent @@ -7,4 +9,6 @@ public class DocumentRenderErrorEvent public string ErrorMessage { get; set; } public string Url { get; set; } + + public Dictionary UserPreferences { get; set; } } \ No newline at end of file diff --git a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs index b3ec299de9..970e967a98 100644 --- a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs +++ b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs @@ -592,7 +592,8 @@ namespace Volo.Docs.Pages.Documents.Project { ErrorMessage = e.Message, Name = Document.Name, - Url = Request.GetDisplayUrl() + Url = Request.GetDisplayUrl(), + UserPreferences = UserPreferences }); // Slow down with crawling From ebf1a9674c3189aeff04316cc9a0c30fb6ed7319 Mon Sep 17 00:00:00 2001 From: Dogan Yildirim Date: Sun, 18 Aug 2024 23:21:06 +0300 Subject: [PATCH 10/21] Updated Tag Names --- .../architecture/best-practices/application-services.md | 2 +- .../architecture/best-practices/data-transfer-objects.md | 2 +- .../en/framework/architecture/best-practices/domain-services.md | 2 +- docs/en/framework/architecture/best-practices/entities.md | 2 +- .../best-practices/entity-framework-core-integration.md | 2 +- docs/en/framework/architecture/best-practices/index.md | 2 +- .../architecture/best-practices/module-architecture.md | 2 +- .../architecture/best-practices/mongodb-integration.md | 2 +- docs/en/framework/architecture/best-practices/repositories.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/en/framework/architecture/best-practices/application-services.md b/docs/en/framework/architecture/best-practices/application-services.md index e3fd00f782..d3ad44ca54 100644 --- a/docs/en/framework/architecture/best-practices/application-services.md +++ b/docs/en/framework/architecture/best-practices/application-services.md @@ -1,4 +1,4 @@ -## Application Services Best Practices & Conventions +# Application Services Best Practices & Conventions * **Do** create an application service for each **aggregate root**. diff --git a/docs/en/framework/architecture/best-practices/data-transfer-objects.md b/docs/en/framework/architecture/best-practices/data-transfer-objects.md index cd3a34513a..e4caa6ed66 100644 --- a/docs/en/framework/architecture/best-practices/data-transfer-objects.md +++ b/docs/en/framework/architecture/best-practices/data-transfer-objects.md @@ -1,4 +1,4 @@ -## Data Transfer Objects Best Practices & Conventions +# Data Transfer Objects Best Practices & Conventions * **Do** define DTOs in the **application contracts** package. * **Do** inherit from the pre-built **base DTO classes** where possible and necessary (like `EntityDto`, `CreationAuditedEntityDto`, `AuditedEntityDto`, `FullAuditedEntityDto` and so on). diff --git a/docs/en/framework/architecture/best-practices/domain-services.md b/docs/en/framework/architecture/best-practices/domain-services.md index b1081d7ebc..565a67a715 100644 --- a/docs/en/framework/architecture/best-practices/domain-services.md +++ b/docs/en/framework/architecture/best-practices/domain-services.md @@ -1,4 +1,4 @@ -## Domain Services Best Practices & Conventions +# Domain Services Best Practices & Conventions ### Domain Service diff --git a/docs/en/framework/architecture/best-practices/entities.md b/docs/en/framework/architecture/best-practices/entities.md index b16234d52b..319f1648ff 100644 --- a/docs/en/framework/architecture/best-practices/entities.md +++ b/docs/en/framework/architecture/best-practices/entities.md @@ -1,4 +1,4 @@ -## Entity Best Practices & Conventions +# Entity Best Practices & Conventions ### Entities diff --git a/docs/en/framework/architecture/best-practices/entity-framework-core-integration.md b/docs/en/framework/architecture/best-practices/entity-framework-core-integration.md index efa622445c..9a2081e4e5 100644 --- a/docs/en/framework/architecture/best-practices/entity-framework-core-integration.md +++ b/docs/en/framework/architecture/best-practices/entity-framework-core-integration.md @@ -1,4 +1,4 @@ -## Entity Framework Core Integration Best Practices +# Entity Framework Core Integration Best Practices > See [Entity Framework Core Integration document](../../data/entity-framework-core) for the basics of the EF Core integration. diff --git a/docs/en/framework/architecture/best-practices/index.md b/docs/en/framework/architecture/best-practices/index.md index 85e00a0b51..49b1e5ec0f 100644 --- a/docs/en/framework/architecture/best-practices/index.md +++ b/docs/en/framework/architecture/best-practices/index.md @@ -1,4 +1,4 @@ -## Module Development Best Practices & Conventions +# Module Development Best Practices & Conventions ### Introduction diff --git a/docs/en/framework/architecture/best-practices/module-architecture.md b/docs/en/framework/architecture/best-practices/module-architecture.md index 25d219b7ac..d050094656 100644 --- a/docs/en/framework/architecture/best-practices/module-architecture.md +++ b/docs/en/framework/architecture/best-practices/module-architecture.md @@ -1,4 +1,4 @@ -## Module Architecture Best Practices & Conventions +# Module Architecture Best Practices & Conventions ### Solution Structure diff --git a/docs/en/framework/architecture/best-practices/mongodb-integration.md b/docs/en/framework/architecture/best-practices/mongodb-integration.md index 16a6a7d58f..36b037c967 100644 --- a/docs/en/framework/architecture/best-practices/mongodb-integration.md +++ b/docs/en/framework/architecture/best-practices/mongodb-integration.md @@ -1,4 +1,4 @@ -## MongoDB Integration +# MongoDB Integration * Do define a separated `MongoDbContext` interface and class for each module. diff --git a/docs/en/framework/architecture/best-practices/repositories.md b/docs/en/framework/architecture/best-practices/repositories.md index 32da1ecee9..5e491ecb80 100644 --- a/docs/en/framework/architecture/best-practices/repositories.md +++ b/docs/en/framework/architecture/best-practices/repositories.md @@ -1,4 +1,4 @@ -## Repository Best Practices & Conventions +# Repository Best Practices & Conventions ### Repository Interfaces From c166d29a5d0b0bcd62b16eebc41ef836dc0ca96f Mon Sep 17 00:00:00 2001 From: Dogan Yildirim Date: Mon, 19 Aug 2024 09:02:54 +0300 Subject: [PATCH 11/21] Updated Title --- docs/en/ambient-context-pattern.md | 2 +- docs/en/aspect-oriented-programming.md | 2 +- docs/en/dynamic-proxying-interceptors.md | 2 +- docs/en/framework/fundamentals/application-startup.md | 2 +- docs/en/ui-themes/lepton-x/angular-customization.md | 2 +- .../how-to-add-a-new-variation-to-lepton-x-for-angular.md | 2 +- .../lepton-x/angular/how-to-change-default-theme-option.md | 2 +- docs/en/ui-themes/lepton-x/comparison-obsolete.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/en/ambient-context-pattern.md b/docs/en/ambient-context-pattern.md index 09f57c6cd7..411db43789 100644 --- a/docs/en/ambient-context-pattern.md +++ b/docs/en/ambient-context-pattern.md @@ -1,3 +1,3 @@ -## Ambient Context Pattern +# Ambient Context Pattern This document is planned to be written later. \ No newline at end of file diff --git a/docs/en/aspect-oriented-programming.md b/docs/en/aspect-oriented-programming.md index 64f0fdb256..c578f1e89c 100644 --- a/docs/en/aspect-oriented-programming.md +++ b/docs/en/aspect-oriented-programming.md @@ -1,3 +1,3 @@ -## Dynamic Proxying / Interceptors +# Dynamic Proxying / Interceptors This document is planned to be written later. \ No newline at end of file diff --git a/docs/en/dynamic-proxying-interceptors.md b/docs/en/dynamic-proxying-interceptors.md index 34c9c69b67..722eadc249 100644 --- a/docs/en/dynamic-proxying-interceptors.md +++ b/docs/en/dynamic-proxying-interceptors.md @@ -1,4 +1,4 @@ -## Dynamic Proxying / Interceptors +# Dynamic Proxying / Interceptors This document is planned to be written later. diff --git a/docs/en/framework/fundamentals/application-startup.md b/docs/en/framework/fundamentals/application-startup.md index 920e1f78cc..e985048714 100644 --- a/docs/en/framework/fundamentals/application-startup.md +++ b/docs/en/framework/fundamentals/application-startup.md @@ -1,4 +1,4 @@ -## ABP Application Startup +# ABP Application Startup You typically use the [ABP CLI](../../cli)'s `abp new` command to [get started](../../get-started/layered-web-application.md) with one of the pre-built [startup solution templates](../../solution-templates). When you do that, you generally don't need to know the details of how the ABP is integrated with your application or how it is configured and initialized. The startup template also comes with the fundamental ABP packages and [application modules](../../modules) are pre-installed and configured for you. diff --git a/docs/en/ui-themes/lepton-x/angular-customization.md b/docs/en/ui-themes/lepton-x/angular-customization.md index 5c570478c2..71ee3761f2 100644 --- a/docs/en/ui-themes/lepton-x/angular-customization.md +++ b/docs/en/ui-themes/lepton-x/angular-customization.md @@ -1,4 +1,4 @@ -## Customization +# Customization ### Layouts diff --git a/docs/en/ui-themes/lepton-x/angular/how-to-add-a-new-variation-to-lepton-x-for-angular.md b/docs/en/ui-themes/lepton-x/angular/how-to-add-a-new-variation-to-lepton-x-for-angular.md index 01ea39c5ec..afea2fd228 100644 --- a/docs/en/ui-themes/lepton-x/angular/how-to-add-a-new-variation-to-lepton-x-for-angular.md +++ b/docs/en/ui-themes/lepton-x/angular/how-to-add-a-new-variation-to-lepton-x-for-angular.md @@ -1,4 +1,4 @@ -## How to Add a New Appearance to LeptonX for Angular +# How to Add a New Appearance to LeptonX for Angular LeptonX has four appearances: light, dim, dark, and system. You can add a new appearance to LeptonX for Angular. In this document, we will show you how to add a new appearance to LeptonX for Angular. ### Step 1: Creating the New Theme Definition diff --git a/docs/en/ui-themes/lepton-x/angular/how-to-change-default-theme-option.md b/docs/en/ui-themes/lepton-x/angular/how-to-change-default-theme-option.md index 961cbc461e..4b58c4b106 100644 --- a/docs/en/ui-themes/lepton-x/angular/how-to-change-default-theme-option.md +++ b/docs/en/ui-themes/lepton-x/angular/how-to-change-default-theme-option.md @@ -1,4 +1,4 @@ -## Configuring the Default Theme for LeptonX +# Configuring the Default Theme for LeptonX The LeptonX theme offers multiple appearances to suit your application's visual style. You can easily configure the default theme for your application using the ThemeLeptonXModule provided by LeptonX. ### Configuration Code diff --git a/docs/en/ui-themes/lepton-x/comparison-obsolete.md b/docs/en/ui-themes/lepton-x/comparison-obsolete.md index 2870be0a8e..e14dcfc368 100644 --- a/docs/en/ui-themes/lepton-x/comparison-obsolete.md +++ b/docs/en/ui-themes/lepton-x/comparison-obsolete.md @@ -1,4 +1,4 @@ -## Feature Set +# Feature Set ### Frontend Choices From 7c4b15c712f713c1eee9b3a74ce59d6bc6c15784 Mon Sep 17 00:00:00 2001 From: sumeyyeKurtulus Date: Mon, 19 Aug 2024 09:19:08 +0300 Subject: [PATCH 12/21] update: smaller padding for the grid template --- .../theme-shared/src/lib/components/toast/toast.component.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss index bc800aebd3..b4be48fb95 100644 --- a/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss +++ b/npm/ng-packs/packages/theme-shared/src/lib/components/toast/toast.component.scss @@ -15,7 +15,7 @@ $toastClass: abp-toast; .#{$toastClass} { display: grid; grid-template-columns: 35px 1fr; - gap: 10px; + gap: 5px; margin: 5px 0; padding: 7px; width: 350px; From 364df4515bed306ca36496ab7d9444e88fca660d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?SAL=C4=B0H=20=C3=96ZKARA?= Date: Mon, 19 Aug 2024 13:44:10 +0300 Subject: [PATCH 13/21] Docs module: Show larger image on the same page --- .../docs/src/Volo.Docs.Web/DocsUiOptions.cs | 2 + .../Pages/Documents/Project/Index.cshtml | 9 ++ .../Pages/Documents/Project/Index.cshtml.cs | 5 +- .../Pages/Documents/Project/enlarge-image.css | 87 +++++++++++++++++++ .../Pages/Documents/Project/enlarge-image.js | 34 ++++++++ 5 files changed, 136 insertions(+), 1 deletion(-) create mode 100644 modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/enlarge-image.css create mode 100644 modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/enlarge-image.js diff --git a/modules/docs/src/Volo.Docs.Web/DocsUiOptions.cs b/modules/docs/src/Volo.Docs.Web/DocsUiOptions.cs index 67af1f3197..702536c31d 100644 --- a/modules/docs/src/Volo.Docs.Web/DocsUiOptions.cs +++ b/modules/docs/src/Volo.Docs.Web/DocsUiOptions.cs @@ -36,6 +36,8 @@ namespace Volo.Docs public bool MultiLanguageMode { get; set; } = true; public SingleProjectModeOptions SingleProjectMode { get; } = new (); + + public bool EnableEnlargeImage { get; set; } = true; private string GetFormattedRoutePrefix() { diff --git a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml index 9507da66ce..2167119a0d 100644 --- a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml +++ b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml @@ -23,6 +23,7 @@ @inject IPageLayout PageLayout @inject IHtmlLocalizer L @inject IOptions DocsWebGoogleOptions +@inject IOptions DocsUiOptions @model IndexModel @{ @@ -40,6 +41,10 @@ + @if (DocsUiOptions.Value.EnableEnlargeImage) + { + + } } @@ -57,6 +62,10 @@ + @if (DocsUiOptions.Value.EnableEnlargeImage) + { + + } if (DocsWebGoogleOptions.Value.EnableGoogleTranslate) { diff --git a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs index 970e967a98..d69d72f038 100644 --- a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs +++ b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs @@ -572,7 +572,10 @@ namespace Volo.Docs.Pages.Documents.Project Document.LocalDirectory ); - content = HtmlNormalizer.WrapImagesWithinAnchors(content); + if (!_uiOptions.EnableEnlargeImage) + { + content = HtmlNormalizer.WrapImagesWithinAnchors(content); + } //todo find a way to make it on client in prismJS configuration (eg: map C# => csharp) content = HtmlNormalizer.ReplaceCodeBlocksLanguage( diff --git a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/enlarge-image.css b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/enlarge-image.css new file mode 100644 index 0000000000..1113d2f914 --- /dev/null +++ b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/enlarge-image.css @@ -0,0 +1,87 @@ +/* The Modal (background) */ +.docs-image-modal { + display: none; /* Hidden by default */ + position: fixed; /* Stay in place */ + z-index: 1; /* Sit on top */ + padding-top: 100px; /* Location of the box */ + left: 0; + top: 0; + width: 100%; /* Full width */ + height: 100%; /* Full height */ + overflow: auto; /* Enable scroll if needed */ + background-color: rgb(41,45,50); /* Fallback color */ + background-color: rgb(41 45 50 / 50%); + cursor: zoom-out; +} + +.docs-image-modal.show { + z-index: 9999; + align-items: center; + display: flex; + padding-top: 0; +} + +/* Modal Content (image) */ +.docs-image-modal .docs-image-modal-content { + margin: auto; + display: block; + background: #fff; + + position: relative; + flex-direction: column; + background-clip: padding-box; + outline: 0; +} + +/* Add Animation */ +.docs-image-modal .docs-image-modal-content{ + -webkit-animation-name: zoom; + -webkit-animation-duration: 0.6s; + animation-name: zoom; + animation-duration: 0.3s; +} + +@-webkit-keyframes zoom { + from {-webkit-transform:scale(0)} + to {-webkit-transform:scale(1)} +} + +@keyframes zoom { + from {transform:scale(0)} + to {transform:scale(1)} +} +/* The Close Button */ +.docs-image-modal .close { + position: absolute; + top: 15px; + right: 35px; + color: #f1f1f1; + transition: 0.3s; + font-size: 48px; + font-weight: 100; +} + +.docs-image-modal .close:hover, +.docs-image-modal .close:focus { + color: #bbb; + text-decoration: none; + cursor: pointer; +} + +/* 100% Image Width on Smaller Screens */ +@media only screen and (max-width: 768px){ + .docs-image-modal .docs-image-modal-content { + max-width: 95vw; + } +} + +@media only screen and (min-width: 768px){ + .docs-image-modal .docs-image-modal-content { + max-width: 80vw; + max-height: 80vh; + } +} + +.docs-enlarge-image { + cursor: zoom-in; +} \ No newline at end of file diff --git a/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/enlarge-image.js b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/enlarge-image.js new file mode 100644 index 0000000000..4e402d8abf --- /dev/null +++ b/modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/enlarge-image.js @@ -0,0 +1,34 @@ +$(function () { + var $enlargeImage = $("article img"); + + if (!$enlargeImage.length) { + return; + } + + $enlargeImage.addClass("docs-enlarge-image"); + + var $modal = $("#image-modal"); + + if (!$modal.length) { + $modal = $("
×
"); + $("body").append($modal); + } + + var modalImg = $modal.find("img"); + $enlargeImage.click(function () { + var width = $(this).width(); + var height = $(this).height(); + modalImg.attr("src", $(this).findWithSelf("img").attr("src")); + modalImg.css("min-width", width + "px"); + modalImg.css("min-height", height + "px"); + $modal.addClass("show"); + }); + + $modal.find(".close").click(modalClose); + + $modal.click(modalClose); + + function modalClose() { + $modal.removeClass("show"); + } +}); \ No newline at end of file From efe8ca68e716ab3970e8707b709b64fba54903a9 Mon Sep 17 00:00:00 2001 From: Dogan Yildirim Date: Tue, 20 Aug 2024 00:17:11 +0300 Subject: [PATCH 14/21] Updated --- docs/en/Blog-Posts/2018-09-24-Announcement/Post.md | 2 +- .../Using-DevExtreme-Components-With-The-ABP-Framework.md | 2 +- .../POST.md | 2 +- .../POST.md | 2 +- .../POST.md | 2 +- .../POST.md | 2 +- .../2023-03-20- IdentityUser-Relationships/Post.md | 2 +- docs/en/framework/infrastructure/concurrency-check.md | 2 +- docs/en/framework/ui/angular/authorization.md | 2 +- docs/en/framework/ui/angular/breadcrumb.md | 2 +- docs/en/framework/ui/angular/extensions-overall.md | 2 +- docs/en/framework/ui/angular/service-proxies.md | 2 +- .../ui/mvc-razor-pages/client-side-package-management.md | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/en/Blog-Posts/2018-09-24-Announcement/Post.md b/docs/en/Blog-Posts/2018-09-24-Announcement/Post.md index dc6f5fa3e8..15ff9d3a3c 100644 --- a/docs/en/Blog-Posts/2018-09-24-Announcement/Post.md +++ b/docs/en/Blog-Posts/2018-09-24-Announcement/Post.md @@ -1,4 +1,4 @@ -### Introduction +# Introduction For a while, we were working to design a new major version of the ASP.NET Boilerplate framework. Now, it’s time to share it with the community. We are too excited and we believe that you are too. #### Naming diff --git a/docs/en/Community-Articles/2020-08-18-Using-DevExtreme-Components-With-The-ABP-Framework/Using-DevExtreme-Components-With-The-ABP-Framework.md b/docs/en/Community-Articles/2020-08-18-Using-DevExtreme-Components-With-The-ABP-Framework/Using-DevExtreme-Components-With-The-ABP-Framework.md index fdaaefbea1..a6e50ab50a 100644 --- a/docs/en/Community-Articles/2020-08-18-Using-DevExtreme-Components-With-The-ABP-Framework/Using-DevExtreme-Components-With-The-ABP-Framework.md +++ b/docs/en/Community-Articles/2020-08-18-Using-DevExtreme-Components-With-The-ABP-Framework/Using-DevExtreme-Components-With-The-ABP-Framework.md @@ -1,4 +1,4 @@ -## Using DevExtreme Components With the ABP Framework +# Using DevExtreme Components With the ABP Framework Hi, in this step by step article, I will show you how to integrate [DevExtreme](https://js.devexpress.com/) components into ABP Framework-based applications. diff --git a/docs/en/Community-Articles/2020-12-10-How-to-Integrate-the-DevExpress-Blazor-Component/POST.md b/docs/en/Community-Articles/2020-12-10-How-to-Integrate-the-DevExpress-Blazor-Component/POST.md index 4f2f5556eb..4b618b81b8 100644 --- a/docs/en/Community-Articles/2020-12-10-How-to-Integrate-the-DevExpress-Blazor-Component/POST.md +++ b/docs/en/Community-Articles/2020-12-10-How-to-Integrate-the-DevExpress-Blazor-Component/POST.md @@ -1,4 +1,4 @@ -## Using DevExpress Blazor UI Components With the ABP Framework +# Using DevExpress Blazor UI Components With the ABP Framework Hi, in this step by step article, I will show you how to integrate [DevExpress](https://demos.devexpress.com/blazor/) blazor UI components into ABP Framework-based applications. diff --git a/docs/en/Community-Articles/2021-01-20-How-to-Integrate-the-MatBlazor-Blazor-Component/POST.md b/docs/en/Community-Articles/2021-01-20-How-to-Integrate-the-MatBlazor-Blazor-Component/POST.md index f30f31d541..551166bdf3 100644 --- a/docs/en/Community-Articles/2021-01-20-How-to-Integrate-the-MatBlazor-Blazor-Component/POST.md +++ b/docs/en/Community-Articles/2021-01-20-How-to-Integrate-the-MatBlazor-Blazor-Component/POST.md @@ -1,4 +1,4 @@ -## Using MatBlazor UI Components With the ABP Framework +# Using MatBlazor UI Components With the ABP Framework Hi, in this step by step article, I will show you how to integrate [MatBlazor](https://www.matblazor.com/), a blazor UI components into ABP Framework-based applications. diff --git a/docs/en/Community-Articles/2021-04-22-How-to-Integrate-the-Syncfusion-Blazor-Component/POST.md b/docs/en/Community-Articles/2021-04-22-How-to-Integrate-the-Syncfusion-Blazor-Component/POST.md index 2e8fa867fb..ae7ee76cd0 100644 --- a/docs/en/Community-Articles/2021-04-22-How-to-Integrate-the-Syncfusion-Blazor-Component/POST.md +++ b/docs/en/Community-Articles/2021-04-22-How-to-Integrate-the-Syncfusion-Blazor-Component/POST.md @@ -1,4 +1,4 @@ -## Integrating SyncFusion UI with ABP Framework Blazor UI +# Integrating SyncFusion UI with ABP Framework Blazor UI Hi, in this step by step article, I will show you how to integrate [Syncfusion](https://www.syncfusion.com/blazor-components), a blazor UI components into ABP Framework-based applications. diff --git a/docs/en/Community-Articles/2023-02-22-Streamline-Localization-In-Your-ABP-Project/POST.md b/docs/en/Community-Articles/2023-02-22-Streamline-Localization-In-Your-ABP-Project/POST.md index 63936521c6..f5380e0f39 100644 --- a/docs/en/Community-Articles/2023-02-22-Streamline-Localization-In-Your-ABP-Project/POST.md +++ b/docs/en/Community-Articles/2023-02-22-Streamline-Localization-In-Your-ABP-Project/POST.md @@ -1,4 +1,4 @@ -## Streamline Localization in Your ABP Project +# Streamline Localization in Your ABP Project Making localization changes to an ABP project can be a daunting task, especially if you're dealing with multiple languages and translations. During development, it's easy to overlook some changes and that leads to inconsistencies across different languages. Fortunately, I have developed a tool that can help streamline the localization process and ensure consistency across different languages. diff --git a/docs/en/Community-Articles/2023-03-20- IdentityUser-Relationships/Post.md b/docs/en/Community-Articles/2023-03-20- IdentityUser-Relationships/Post.md index 48db4e9557..ba01acce81 100644 --- a/docs/en/Community-Articles/2023-03-20- IdentityUser-Relationships/Post.md +++ b/docs/en/Community-Articles/2023-03-20- IdentityUser-Relationships/Post.md @@ -1,4 +1,4 @@ -## Introduction +# Introduction In this article, I will talk about the relationships of IdentityUser in every web application that can be created with the ABP framework. When you read this article, you will learn how to extend the user entity in the applications you develop using the ABP framework with a primitive type, extending the user by associating the user with another entity (User-many-to-one-X). diff --git a/docs/en/framework/infrastructure/concurrency-check.md b/docs/en/framework/infrastructure/concurrency-check.md index 03e5aafc90..731750f306 100644 --- a/docs/en/framework/infrastructure/concurrency-check.md +++ b/docs/en/framework/infrastructure/concurrency-check.md @@ -1,4 +1,4 @@ -## Concurrency Check +# Concurrency Check ### Introduction diff --git a/docs/en/framework/ui/angular/authorization.md b/docs/en/framework/ui/angular/authorization.md index 04bc9ab991..dcf6e0c67d 100644 --- a/docs/en/framework/ui/angular/authorization.md +++ b/docs/en/framework/ui/angular/authorization.md @@ -1,4 +1,4 @@ -## Authorization in Angular UI +# Authorization in Angular UI OAuth is preconfigured in Angular application templates. So, when you start a project using the CLI (or Suite, for that matter), authorization already works. ABP Angular UI packages are using [angular-oauth2-oidc library](https://github.com/manfredsteyer/angular-oauth2-oidc#logging-in) for managing OAuth in the Angular client. You can find **OAuth configuration** in the _environment.ts_ files. diff --git a/docs/en/framework/ui/angular/breadcrumb.md b/docs/en/framework/ui/angular/breadcrumb.md index 77351b8236..1a26975c96 100644 --- a/docs/en/framework/ui/angular/breadcrumb.md +++ b/docs/en/framework/ui/angular/breadcrumb.md @@ -1,4 +1,4 @@ -## Breadcrumb Component +# Breadcrumb Component ABP provides a component that listens to the angular router's `NavigationEnd` event and creates inputs for `BreadcrumbItemsComponent`. This component is used in diff --git a/docs/en/framework/ui/angular/extensions-overall.md b/docs/en/framework/ui/angular/extensions-overall.md index bba922461b..4776198001 100644 --- a/docs/en/framework/ui/angular/extensions-overall.md +++ b/docs/en/framework/ui/angular/extensions-overall.md @@ -1,4 +1,4 @@ -## Angular UI Extensions +# Angular UI Extensions Angular UI extensions system allows you to add a new action to the actions menu, a new column to the data table, a new action to the toolbar of a page, and add a new field to the create and/or edit forms. diff --git a/docs/en/framework/ui/angular/service-proxies.md b/docs/en/framework/ui/angular/service-proxies.md index 99e6e781c2..695e3027c4 100644 --- a/docs/en/framework/ui/angular/service-proxies.md +++ b/docs/en/framework/ui/angular/service-proxies.md @@ -1,4 +1,4 @@ -## Service Proxies +# Service Proxies Calling a REST endpoint from Angular applications is common. We usually create **services** matching server-side controllers and **interfaces** matching [DTOs](../../architecture/domain-driven-design/data-transfer-objects.md) to interact with the server. This often results in manually transforming C# code into TypeScript equivalents and that is unfortunate, if not intolerable. diff --git a/docs/en/framework/ui/mvc-razor-pages/client-side-package-management.md b/docs/en/framework/ui/mvc-razor-pages/client-side-package-management.md index 2e7515884a..bb984a001f 100644 --- a/docs/en/framework/ui/mvc-razor-pages/client-side-package-management.md +++ b/docs/en/framework/ui/mvc-razor-pages/client-side-package-management.md @@ -1,5 +1,5 @@ -## ASP.NET Core MVC Client Side Package Management +# ASP.NET Core MVC Client Side Package Management ABP can work with any type of client side package management systems. You can even decide to use no package management system and manage your dependencies manually. From d02187c20cc1ab9ba276a9b3e4f93775351e8786 Mon Sep 17 00:00:00 2001 From: Dogan Yildirim Date: Tue, 20 Aug 2024 10:01:00 +0300 Subject: [PATCH 15/21] Updated --- docs/en/Blog-Posts/2018-09-24-Announcement/Post.md | 2 +- .../Using-DevExtreme-Components-With-The-ABP-Framework.md | 2 +- .../POST.md | 2 +- .../POST.md | 2 +- .../POST.md | 2 +- .../POST.md | 2 +- .../2023-03-20- IdentityUser-Relationships/Post.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/en/Blog-Posts/2018-09-24-Announcement/Post.md b/docs/en/Blog-Posts/2018-09-24-Announcement/Post.md index 15ff9d3a3c..dc6f5fa3e8 100644 --- a/docs/en/Blog-Posts/2018-09-24-Announcement/Post.md +++ b/docs/en/Blog-Posts/2018-09-24-Announcement/Post.md @@ -1,4 +1,4 @@ -# Introduction +### Introduction For a while, we were working to design a new major version of the ASP.NET Boilerplate framework. Now, it’s time to share it with the community. We are too excited and we believe that you are too. #### Naming diff --git a/docs/en/Community-Articles/2020-08-18-Using-DevExtreme-Components-With-The-ABP-Framework/Using-DevExtreme-Components-With-The-ABP-Framework.md b/docs/en/Community-Articles/2020-08-18-Using-DevExtreme-Components-With-The-ABP-Framework/Using-DevExtreme-Components-With-The-ABP-Framework.md index a6e50ab50a..fdaaefbea1 100644 --- a/docs/en/Community-Articles/2020-08-18-Using-DevExtreme-Components-With-The-ABP-Framework/Using-DevExtreme-Components-With-The-ABP-Framework.md +++ b/docs/en/Community-Articles/2020-08-18-Using-DevExtreme-Components-With-The-ABP-Framework/Using-DevExtreme-Components-With-The-ABP-Framework.md @@ -1,4 +1,4 @@ -# Using DevExtreme Components With the ABP Framework +## Using DevExtreme Components With the ABP Framework Hi, in this step by step article, I will show you how to integrate [DevExtreme](https://js.devexpress.com/) components into ABP Framework-based applications. diff --git a/docs/en/Community-Articles/2020-12-10-How-to-Integrate-the-DevExpress-Blazor-Component/POST.md b/docs/en/Community-Articles/2020-12-10-How-to-Integrate-the-DevExpress-Blazor-Component/POST.md index 4b618b81b8..4f2f5556eb 100644 --- a/docs/en/Community-Articles/2020-12-10-How-to-Integrate-the-DevExpress-Blazor-Component/POST.md +++ b/docs/en/Community-Articles/2020-12-10-How-to-Integrate-the-DevExpress-Blazor-Component/POST.md @@ -1,4 +1,4 @@ -# Using DevExpress Blazor UI Components With the ABP Framework +## Using DevExpress Blazor UI Components With the ABP Framework Hi, in this step by step article, I will show you how to integrate [DevExpress](https://demos.devexpress.com/blazor/) blazor UI components into ABP Framework-based applications. diff --git a/docs/en/Community-Articles/2021-01-20-How-to-Integrate-the-MatBlazor-Blazor-Component/POST.md b/docs/en/Community-Articles/2021-01-20-How-to-Integrate-the-MatBlazor-Blazor-Component/POST.md index 551166bdf3..f30f31d541 100644 --- a/docs/en/Community-Articles/2021-01-20-How-to-Integrate-the-MatBlazor-Blazor-Component/POST.md +++ b/docs/en/Community-Articles/2021-01-20-How-to-Integrate-the-MatBlazor-Blazor-Component/POST.md @@ -1,4 +1,4 @@ -# Using MatBlazor UI Components With the ABP Framework +## Using MatBlazor UI Components With the ABP Framework Hi, in this step by step article, I will show you how to integrate [MatBlazor](https://www.matblazor.com/), a blazor UI components into ABP Framework-based applications. diff --git a/docs/en/Community-Articles/2021-04-22-How-to-Integrate-the-Syncfusion-Blazor-Component/POST.md b/docs/en/Community-Articles/2021-04-22-How-to-Integrate-the-Syncfusion-Blazor-Component/POST.md index ae7ee76cd0..2e8fa867fb 100644 --- a/docs/en/Community-Articles/2021-04-22-How-to-Integrate-the-Syncfusion-Blazor-Component/POST.md +++ b/docs/en/Community-Articles/2021-04-22-How-to-Integrate-the-Syncfusion-Blazor-Component/POST.md @@ -1,4 +1,4 @@ -# Integrating SyncFusion UI with ABP Framework Blazor UI +## Integrating SyncFusion UI with ABP Framework Blazor UI Hi, in this step by step article, I will show you how to integrate [Syncfusion](https://www.syncfusion.com/blazor-components), a blazor UI components into ABP Framework-based applications. diff --git a/docs/en/Community-Articles/2023-02-22-Streamline-Localization-In-Your-ABP-Project/POST.md b/docs/en/Community-Articles/2023-02-22-Streamline-Localization-In-Your-ABP-Project/POST.md index f5380e0f39..63936521c6 100644 --- a/docs/en/Community-Articles/2023-02-22-Streamline-Localization-In-Your-ABP-Project/POST.md +++ b/docs/en/Community-Articles/2023-02-22-Streamline-Localization-In-Your-ABP-Project/POST.md @@ -1,4 +1,4 @@ -# Streamline Localization in Your ABP Project +## Streamline Localization in Your ABP Project Making localization changes to an ABP project can be a daunting task, especially if you're dealing with multiple languages and translations. During development, it's easy to overlook some changes and that leads to inconsistencies across different languages. Fortunately, I have developed a tool that can help streamline the localization process and ensure consistency across different languages. diff --git a/docs/en/Community-Articles/2023-03-20- IdentityUser-Relationships/Post.md b/docs/en/Community-Articles/2023-03-20- IdentityUser-Relationships/Post.md index ba01acce81..48db4e9557 100644 --- a/docs/en/Community-Articles/2023-03-20- IdentityUser-Relationships/Post.md +++ b/docs/en/Community-Articles/2023-03-20- IdentityUser-Relationships/Post.md @@ -1,4 +1,4 @@ -# Introduction +## Introduction In this article, I will talk about the relationships of IdentityUser in every web application that can be created with the ABP framework. When you read this article, you will learn how to extend the user entity in the applications you develop using the ABP framework with a primitive type, extending the user by associating the user with another entity (User-many-to-one-X). From 340f082b84af31eda4eb29000d27051d495245ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Tue, 20 Aug 2024 11:48:18 +0300 Subject: [PATCH 16/21] Improvement for the overview usage --- docs/en/framework/api-development/overview.md | 4 ++-- docs/en/framework/api-development/standard-apis/overview.md | 4 ++-- .../architecture/best-practices/application-layer-overview.md | 2 +- .../architecture/best-practices/data-access-overview.md | 2 +- .../architecture/best-practices/domain-layer-overview.md | 2 +- docs/en/framework/fundamentals/overview.md | 2 +- docs/en/framework/infrastructure/overview.md | 4 ++-- docs/en/framework/ui/overview.md | 2 +- docs/en/release-info/overview.md | 2 +- docs/en/tools.md | 2 +- docs/en/tutorials/overview.md | 4 ++-- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/en/framework/api-development/overview.md b/docs/en/framework/api-development/overview.md index 9d7e215896..4b2105486d 100644 --- a/docs/en/framework/api-development/overview.md +++ b/docs/en/framework/api-development/overview.md @@ -1,6 +1,6 @@ -## API Development: Overview +## API Development -ABP provides a set of features and integrations to third-party libraries to easily develop APIs. Here, is the list of documents that you can refer to while developing APIs: +The following documents explain the concepts, infrastructure and integrations to build HTTP APIs with ABP: * [ABP Endpoints](./standard-apis/overview.md) * [API Versioning](./versioning.md) diff --git a/docs/en/framework/api-development/standard-apis/overview.md b/docs/en/framework/api-development/standard-apis/overview.md index 7dc0666bdd..3dd4a284f5 100644 --- a/docs/en/framework/api-development/standard-apis/overview.md +++ b/docs/en/framework/api-development/standard-apis/overview.md @@ -1,6 +1,6 @@ -## ABP Endpoints +## Standard HTTP API Endpoints -ABP provides pre-built and standart endpoints that contains some useful information about the application/service, such as localization entries and settings. Here, is the list of some pre-built endpoints: +ABP provides some pre-built and standard endpoints that contains useful information about the application or service, such as localization entries and settings. Here, is the list of the pre-built endpoints: * [Application Configuration](./configuration.md) * [Application Localization](./localization.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/application-layer-overview.md b/docs/en/framework/architecture/best-practices/application-layer-overview.md index b7650d6699..10afeeb9ca 100644 --- a/docs/en/framework/architecture/best-practices/application-layer-overview.md +++ b/docs/en/framework/architecture/best-practices/application-layer-overview.md @@ -1,6 +1,6 @@ ## Best Practices: Application Layer -ABP suggests some best-practices that you can use while implementing the Application Layer by following Domain Driven Design principles: +The following documents suggest some best-practices that you can use while implementing the application layer of your solution by following the Domain Driven Design principles: * [Application Services](./application-services.md) * [Data Transfer Objects](./data-transfer-objects.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/data-access-overview.md b/docs/en/framework/architecture/best-practices/data-access-overview.md index 3c0aa1a9c7..1369a21e32 100644 --- a/docs/en/framework/architecture/best-practices/data-access-overview.md +++ b/docs/en/framework/architecture/best-practices/data-access-overview.md @@ -1,6 +1,6 @@ ## Best Practices: Data Access -ABP suggests some best-practices that you can use while implementing the Infrastructure Layer (integrations) by following Domain Driven Design principles: +The following documents suggest some best-practices that you can use while implementing the database integration layer of your solution by following Domain Driven Design principles: * [Entity Framework Core](./entity-framework-core-integration.md) * [MongoDB](./mongodb-integration.md) \ No newline at end of file diff --git a/docs/en/framework/architecture/best-practices/domain-layer-overview.md b/docs/en/framework/architecture/best-practices/domain-layer-overview.md index 995d545cb5..b20ae1b208 100644 --- a/docs/en/framework/architecture/best-practices/domain-layer-overview.md +++ b/docs/en/framework/architecture/best-practices/domain-layer-overview.md @@ -1,6 +1,6 @@ ## Best Practices: Domain Layer -ABP suggests some best-practices that you can use while implementing the Domain Layer by following Domain Driven Design principles: +The following documents suggest some best-practices that you can use while implementing the domain layer of your solution by following the Domain Driven Design principles: * [Entities](./entities.md) * [Repositories](./repositories.md) diff --git a/docs/en/framework/fundamentals/overview.md b/docs/en/framework/fundamentals/overview.md index b09e8c5d5a..7ce2c59f7b 100644 --- a/docs/en/framework/fundamentals/overview.md +++ b/docs/en/framework/fundamentals/overview.md @@ -1,6 +1,6 @@ ## ABP Fundamentals: Overview -ABP provides fundamental documents that explain to you the core building-blocks of ABP & .NET applications. Here, is the full list of the fundamental documents: +The following documents explains the fundamental building blocks to create ABP solutions: * [Application Startup](./application-startup.md) * [Authorization](./authorization.md) diff --git a/docs/en/framework/infrastructure/overview.md b/docs/en/framework/infrastructure/overview.md index df52f222db..f9524216c3 100644 --- a/docs/en/framework/infrastructure/overview.md +++ b/docs/en/framework/infrastructure/overview.md @@ -1,6 +1,6 @@ -## ABP Infrastructure: Overview +## ABP Infrastructure -ABP provides a complete infrastructure for creating software solutions with modern architectures based on .NET platform: +ABP provides a complete infrastructure for creating real world software solutions with modern architectures based on the .NET platform. Each of the following documents explains an infrastructure feature: * [Audit Logging](./audit-logging.md) * [Background Jobs](./background-jobs/index.md) diff --git a/docs/en/framework/ui/overview.md b/docs/en/framework/ui/overview.md index 8ae4cd5b0e..760a2616b0 100644 --- a/docs/en/framework/ui/overview.md +++ b/docs/en/framework/ui/overview.md @@ -1,4 +1,4 @@ -## ABP: UI Options +## ABP UI Options ABP provides several options for building the user interface (UI) in your applications. Here are some of the officially supported UI options you can use with ABP: diff --git a/docs/en/release-info/overview.md b/docs/en/release-info/overview.md index 3a2d4704d6..eb6a4ef602 100644 --- a/docs/en/release-info/overview.md +++ b/docs/en/release-info/overview.md @@ -1,4 +1,4 @@ -## Release Information: Overview +## Release Information * [Release Notes](./release-notes.md) * [Migration Guides](./migration-guides/index.md) diff --git a/docs/en/tools.md b/docs/en/tools.md index aa7d048d95..356db9f639 100644 --- a/docs/en/tools.md +++ b/docs/en/tools.md @@ -4,4 +4,4 @@ ABP provides a comprehensive set of tools designed to enhance the development ex * [ABP CLI](./cli/index.md): Command line tool to perform some common operations for ABP based solutions. * [ABP Suite](./suite/index.md): A complementary tool that allows you to build web pages in a matter of minutes. -* [ABP Studio](./studio/index.md): **Cross-platform** desktop application for ABP and .NET developers. Aims to provide a comfortable development environment for you by automating things, providing insights about your solution, making develop, run, browse, monitor, trace and deploy your solutions much easier. \ No newline at end of file +* [ABP Studio](./studio/index.md): A cross-platform desktop application for ABP and .NET developers. Aims to provide a comfortable development environment for you by automating things, providing insights about your solution, making develop, run, browse, monitor, trace and deploy your solutions much easier. \ No newline at end of file diff --git a/docs/en/tutorials/overview.md b/docs/en/tutorials/overview.md index 357649f5b3..aac3abfaed 100644 --- a/docs/en/tutorials/overview.md +++ b/docs/en/tutorials/overview.md @@ -1,6 +1,6 @@ -## ABP Tutorials: Overview +## ABP Tutorials -This document provides an overview of essential tutorials that will help you get started with ABP platform: +The following guides explains how to build ABP based applications: * [TODO Application](todo/index.md): This is a single-part, quick-start tutorial to build a simple application with ABP. Start with this tutorial if you want to quickly understand how ABP works. * [Book Store Application](book-store/overview.md): This is a multi-part, complete tutorial to build a bookstore application with ABP. Start with this tutorial if you want to create a layered solution with ABP and apply DDD best practices. \ No newline at end of file From 2146e023826f3a15363e177729ffdd96a83d5d5e Mon Sep 17 00:00:00 2001 From: Yunus Emre Kalkan Date: Tue, 20 Aug 2024 13:10:48 +0300 Subject: [PATCH 17/21] Publish Volo.Abp.AuditLogging.SourceCode --- nupkg/common.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nupkg/common.ps1 b/nupkg/common.ps1 index 9f014cd526..9ed8653690 100644 --- a/nupkg/common.ps1 +++ b/nupkg/common.ps1 @@ -265,8 +265,8 @@ $projects = ( "modules/audit-logging/src/Volo.Abp.AuditLogging.Domain.Shared", "modules/audit-logging/src/Volo.Abp.AuditLogging.EntityFrameworkCore", "modules/audit-logging/src/Volo.Abp.AuditLogging.MongoDB", - # "modules/audit-logging/src/Volo.Abp.AuditLogging.Installer", - # "source-code/Volo.Abp.AuditLogging.SourceCode", + "modules/audit-logging/src/Volo.Abp.AuditLogging.Installer", + "source-code/Volo.Abp.AuditLogging.SourceCode", # modules/background-jobs "modules/background-jobs/src/Volo.Abp.BackgroundJobs.Domain", From be01c5444a24bb45e5e7cfebfba0bb9c30c95beb Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Tue, 20 Aug 2024 14:19:18 +0300 Subject: [PATCH 18/21] rename overview.md to index.md for several docs. --- docs/en/docs-nav.json | 18 +++++++++--------- .../api-development/{overview.md => index.md} | 0 .../standard-apis/{overview.md => index.md} | 0 .../fundamentals/{overview.md => index.md} | 0 .../infrastructure/{overview.md => index.md} | 0 docs/en/framework/ui/{overview.md => index.md} | 0 docs/en/release-info/{overview.md => index.md} | 0 .../book-store/{overview.md => index.md} | 0 docs/en/tutorials/{overview.md => index.md} | 0 9 files changed, 9 insertions(+), 9 deletions(-) rename docs/en/framework/api-development/{overview.md => index.md} (100%) rename docs/en/framework/api-development/standard-apis/{overview.md => index.md} (100%) rename docs/en/framework/fundamentals/{overview.md => index.md} (100%) rename docs/en/framework/infrastructure/{overview.md => index.md} (100%) rename docs/en/framework/ui/{overview.md => index.md} (100%) rename docs/en/release-info/{overview.md => index.md} (100%) rename docs/en/tutorials/book-store/{overview.md => index.md} (100%) rename docs/en/tutorials/{overview.md => index.md} (100%) diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index caabea99cb..4b15860937 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -47,7 +47,7 @@ "items": [ { "text": "Overview", - "path": "tutorials/overview.md" + "path": "tutorials/index.md" }, { "text": "TODO application", @@ -71,7 +71,7 @@ "items": [ { "text": "Overview", - "path": "tutorials/book-store/overview.md" + "path": "tutorials/book-store/index.md" }, { "text": "1: Creating the server side", @@ -267,7 +267,7 @@ "items": [ { "text": "Overview", - "path": "framework/fundamentals/overview.md" + "path": "framework/fundamentals/index.md" }, { "text": "Application Startup", @@ -360,7 +360,7 @@ "items": [ { "text": "Overview", - "path": "framework/infrastructure/overview.md" + "path": "framework/infrastructure/index.md" }, { "text": "Audit Logging", @@ -783,14 +783,14 @@ "items": [ { "text": "Overview", - "path": "framework/api-development/overview.md" + "path": "framework/api-development/index.md" }, { "text": "ABP Endpoints", "items": [ { "text": "Overview", - "path": "framework/api-development/standard-apis/overview.md" + "path": "framework/api-development/standard-apis/index.md" }, { "text": "Application Configuration", @@ -833,14 +833,14 @@ "items": [ { "text": "Overview", - "path": "framework/ui/overview.md" + "path": "framework/ui/index.md" }, { "text": "MVC / Razor Pages", "items": [ { "text": "Overview", - "path": "framework/ui/mvc-razor-pages/overall.md" + "path": "framework/ui/mvc-razor-pages/index.md" }, { "text": "Navigation / Menus", @@ -1849,7 +1849,7 @@ "items": [ { "text": "Overview", - "path": "release-info/overview.md" + "path": "release-info/index.md" }, { "text": "Release Notes", diff --git a/docs/en/framework/api-development/overview.md b/docs/en/framework/api-development/index.md similarity index 100% rename from docs/en/framework/api-development/overview.md rename to docs/en/framework/api-development/index.md diff --git a/docs/en/framework/api-development/standard-apis/overview.md b/docs/en/framework/api-development/standard-apis/index.md similarity index 100% rename from docs/en/framework/api-development/standard-apis/overview.md rename to docs/en/framework/api-development/standard-apis/index.md diff --git a/docs/en/framework/fundamentals/overview.md b/docs/en/framework/fundamentals/index.md similarity index 100% rename from docs/en/framework/fundamentals/overview.md rename to docs/en/framework/fundamentals/index.md diff --git a/docs/en/framework/infrastructure/overview.md b/docs/en/framework/infrastructure/index.md similarity index 100% rename from docs/en/framework/infrastructure/overview.md rename to docs/en/framework/infrastructure/index.md diff --git a/docs/en/framework/ui/overview.md b/docs/en/framework/ui/index.md similarity index 100% rename from docs/en/framework/ui/overview.md rename to docs/en/framework/ui/index.md diff --git a/docs/en/release-info/overview.md b/docs/en/release-info/index.md similarity index 100% rename from docs/en/release-info/overview.md rename to docs/en/release-info/index.md diff --git a/docs/en/tutorials/book-store/overview.md b/docs/en/tutorials/book-store/index.md similarity index 100% rename from docs/en/tutorials/book-store/overview.md rename to docs/en/tutorials/book-store/index.md diff --git a/docs/en/tutorials/overview.md b/docs/en/tutorials/index.md similarity index 100% rename from docs/en/tutorials/overview.md rename to docs/en/tutorials/index.md From 30a2b33483d9eb963b0e2be0c8553396d3734c37 Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Tue, 20 Aug 2024 14:23:15 +0300 Subject: [PATCH 19/21] Update docs-nav.json --- docs/en/docs-nav.json | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index 4b15860937..5222de9a06 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -5,7 +5,7 @@ "items": [ { "text": "Overview", - "path": "get-started/index.md" + "path": "get-started" }, { "text": "Single-layer solution", @@ -47,14 +47,14 @@ "items": [ { "text": "Overview", - "path": "tutorials/index.md" + "path": "tutorials" }, { "text": "TODO application", "items": [ { "text": "Overview", - "path": "tutorials/todo/index.md" + "path": "tutorials/todo" }, { "text": "Single-layer solution", @@ -71,7 +71,7 @@ "items": [ { "text": "Overview", - "path": "tutorials/book-store/index.md" + "path": "tutorials/book-store" }, { "text": "1: Creating the server side", @@ -133,7 +133,7 @@ "items": [ { "text": "Overview", - "path": "cli/index.md" + "path": "cli" }, { "text": "Examples for the new command", @@ -146,7 +146,7 @@ "items": [ { "text": "Overview", - "path": "studio/index.md" + "path": "studio" }, { "text": "Installation", @@ -267,7 +267,7 @@ "items": [ { "text": "Overview", - "path": "framework/fundamentals/index.md" + "path": "framework/fundamentals" }, { "text": "Application Startup", @@ -360,7 +360,7 @@ "items": [ { "text": "Overview", - "path": "framework/infrastructure/index.md" + "path": "framework/infrastructure" }, { "text": "Audit Logging", @@ -783,14 +783,14 @@ "items": [ { "text": "Overview", - "path": "framework/api-development/index.md" + "path": "framework/api-development" }, { "text": "ABP Endpoints", "items": [ { "text": "Overview", - "path": "framework/api-development/standard-apis/index.md" + "path": "framework/api-development/standard-apis" }, { "text": "Application Configuration", @@ -833,14 +833,14 @@ "items": [ { "text": "Overview", - "path": "framework/ui/index.md" + "path": "framework/ui" }, { "text": "MVC / Razor Pages", "items": [ { "text": "Overview", - "path": "framework/ui/mvc-razor-pages/index.md" + "path": "framework/ui/mvc-razor-pages" }, { "text": "Navigation / Menus", @@ -1740,7 +1740,7 @@ "items": [ { "text": "Overview", - "path": "ui-themes/index.md" + "path": "ui-themes" }, { "text": "The Basic Theme", @@ -1748,7 +1748,7 @@ }, { "text": "LeptonX Theme", - "path": "ui-themes/lepton-x/index.md" + "path": "ui-themes/lepton-x" } ] }, @@ -1849,7 +1849,7 @@ "items": [ { "text": "Overview", - "path": "release-info/index.md" + "path": "release-info" }, { "text": "Release Notes", From 8051dd5c34a7bef94b26e64fef1d968d5aaf1d68 Mon Sep 17 00:00:00 2001 From: ahmetfarukulu Date: Tue, 20 Aug 2024 15:20:24 +0300 Subject: [PATCH 20/21] ABP CLI documentation new options added --- docs/en/cli/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/cli/index.md b/docs/en/cli/index.md index c283121ce5..a25ed0c4eb 100644 --- a/docs/en/cli/index.md +++ b/docs/en/cli/index.md @@ -105,6 +105,8 @@ abp cli update abp cli update --preview abp cli update --version 1.0.0 abp cli remove +abp cli check-version +abp cli clear-cache ```` ### new From 1d3fe8685378be45ec91ad0c5ae8d61e36690398 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?SAL=C4=B0H=20=C3=96ZKARA?= Date: Wed, 21 Aug 2024 12:55:08 +0300 Subject: [PATCH 21/21] Add Yaml Support --- .../Bundling/PrismjsScriptBundleContributorDocsExtension.cs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/docs/src/Volo.Docs.Web/Bundling/PrismjsScriptBundleContributorDocsExtension.cs b/modules/docs/src/Volo.Docs.Web/Bundling/PrismjsScriptBundleContributorDocsExtension.cs index 3fc129bf55..0be1e7cb29 100644 --- a/modules/docs/src/Volo.Docs.Web/Bundling/PrismjsScriptBundleContributorDocsExtension.cs +++ b/modules/docs/src/Volo.Docs.Web/Bundling/PrismjsScriptBundleContributorDocsExtension.cs @@ -23,7 +23,8 @@ namespace Volo.Docs.Bundling "scss", "sql", "typescript", - "diff" + "diff", + "yaml" }; public override void ConfigureBundle(BundleConfigurationContext context)