From 34803a17c031dc4b8f5c7348a710cac90a34abb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Wed, 15 May 2024 00:12:49 +0200 Subject: [PATCH 1/2] Adding benchmarking docs --- mkdocs.yml | 1 + src/docs/guides/contributing/README.md | 1 + src/docs/guides/contributing/benchmarking.md | 15 +++++++++++++++ 3 files changed, 17 insertions(+) create mode 100644 src/docs/guides/contributing/benchmarking.md diff --git a/mkdocs.yml b/mkdocs.yml index 1aaf4108e48..73ffe5f8477 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -130,6 +130,7 @@ nav: - Contributing code: guides/contributing/contributing-code.md - Contributing documentation: guides/contributing/contributing-documentation.md - Reviewing pull requests: guides/contributing/reviewing-pull-requests.md + - Benchmarking: guides/contributing/benchmarking.md - Gulp pipeline: guides/gulp-pipeline/README.md - Key Topics: - Manage your Content: topics/content-management/README.md diff --git a/src/docs/guides/contributing/README.md b/src/docs/guides/contributing/README.md index 75948cb4da0..a6bb978f43c 100644 --- a/src/docs/guides/contributing/README.md +++ b/src/docs/guides/contributing/README.md @@ -9,6 +9,7 @@ One of the easiest ways to contribute is to participate in discussions under [Gi - [Contributing code](contributing-code.md) - [Contributing documentation](contributing-documentation.md) - [Reviewing pull requests](reviewing-pull-requests.md) +- [Benchmarking](benchmarking.md) ## Contributor License Agreement diff --git a/src/docs/guides/contributing/benchmarking.md b/src/docs/guides/contributing/benchmarking.md new file mode 100644 index 00000000000..77ce4acc02e --- /dev/null +++ b/src/docs/guides/contributing/benchmarking.md @@ -0,0 +1,15 @@ +# Benchmarking + +To measure how fast Orchard Core is (usually, it's pretty fast :)), we employ some benchmarking. You can help extend the benchmarking suite too! (See the [code contribution guidelines](contributing-code.md).) + +## `OrchardCore.Benchmarks` + +In the [`OrchardCore.Benchmarks` project](https://github.com/OrchardCMS/OrchardCore/tree/main/test/OrchardCore.Benchmarks) we have several benchmarks created with [BenchmarkDotNet](https://benchmarkdotnet.org/). When we troubleshoot some performance issue, we extend these to measure the performance impact of the changes. + +### Running `OrchardCore.Benchmarks` benchmarks + +The project is a console application. Build the whole solution in Release mode, then run `OrchardCore.Benchmarks` (it'll be under `test/OrchardCore.Benchmarks/bin/Release/net8.0/OrchardCore.Benchmarks.exe`): You'll see a CLI menu to select which benchmark to run. Alternatively, you can use one of BenchmarkDotNet's [console arguments](https://benchmarkdotnet.org/articles/guides/console-args.html). + +## ASP.NET Core Benchmarks + +The [ASP.NET Core Benchmarks](https://github.com/aspnet/Benchmarks) also include some continuous benchmarks of Orchard Core. The results can be seen under , among the MVC benchmarks (select "MVC" from the menu by clicking the page numbers at the bottom; direct link [here](https://msit.powerbi.com/view?r=eyJrIjoiYTZjMTk3YjEtMzQ3Yi00NTI5LTg5ZDItNmUyMGRlOTkwMGRlIiwidCI6IjcyZjk4OGJmLTg2ZjEtNDFhZi05MWFiLTJkN2NkMDExZGI0NyIsImMiOjV9&pageName=ReportSection36a3b7283aa365d8de32)). \ No newline at end of file From 47205009b22363cfc35ca620ca23a92da187f7dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Wed, 15 May 2024 00:28:15 +0200 Subject: [PATCH 2/2] Typo Co-authored-by: Hisham Bin Ateya --- src/docs/guides/contributing/benchmarking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/benchmarking.md b/src/docs/guides/contributing/benchmarking.md index 77ce4acc02e..cfa5c0045dc 100644 --- a/src/docs/guides/contributing/benchmarking.md +++ b/src/docs/guides/contributing/benchmarking.md @@ -4,7 +4,7 @@ To measure how fast Orchard Core is (usually, it's pretty fast :)), we employ so ## `OrchardCore.Benchmarks` -In the [`OrchardCore.Benchmarks` project](https://github.com/OrchardCMS/OrchardCore/tree/main/test/OrchardCore.Benchmarks) we have several benchmarks created with [BenchmarkDotNet](https://benchmarkdotnet.org/). When we troubleshoot some performance issue, we extend these to measure the performance impact of the changes. +In the [`OrchardCore.Benchmarks` project](https://github.com/OrchardCMS/OrchardCore/tree/main/test/OrchardCore.Benchmarks) we have several benchmarks created with [BenchmarkDotNet](https://benchmarkdotnet.org/). When we troubleshoot some performance issues, we extend these to measure the performance impact of the changes. ### Running `OrchardCore.Benchmarks` benchmarks