From 81b0ab553e81b80c7223ced886c211ff7dadc369 Mon Sep 17 00:00:00 2001 From: Ralf Koller Date: Wed, 29 Nov 2023 02:58:46 +0100 Subject: [PATCH 1/2] Remove some redundacny and adjust the case of the XHGui wordmark --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6239cca..38cb328 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,6 @@ Profiling in a production environment is not recommended. } ``` -- Run `ddev xhprof` to start profiling. - - XHGui is now available at `https://yourproject.ddev.site:8142` - ### WordPress - Install `perftools/php-profiler` @@ -81,8 +78,6 @@ Profiling in a production environment is not recommended. ``` - Remove `#ddev-generated` from `wp-config-ddev.php` to prevent DDEV overriding it. -- Run `ddev xhprof` to start profiling - - XHGui is now available at `https://yourproject.ddev.site:8142` ### Silverstripe @@ -109,20 +104,21 @@ Profiling in a production environment is not recommended. } ``` -- Run `ddev xhprof` to start profiling - - XHGui is now available at `https://yourproject.ddev.site:8142` - ## Usage +Make sure your project is started then use the following command to enable profiling. -The service will automatically start when run: `ddev start` or `ddev restart`. +```shell +ddev xhprof +``` -By default, xhgui will be available at `https://yourproject.ddev.site:8143`. -Use the following command to launch the xhgui in your browser: +Next use the following command to launch the XHGui in your browser: ```shell ddev xhgui ``` +By default, XHGui will be available at `https://yourproject.ddev.site:8143`. + For detailed information about a single request, click on the "Method" keyword on the "Recent runs" dashboard. ![Click GET method](./images/xhgui-get.png) @@ -137,9 +133,9 @@ Use the following command to check the logs: ## Configuration -To configure Xhgui, update `.ddev/xhgui/xhgui.config.php`. +To configure XhGui, update `.ddev/xhgui/xhgui.config.php`. -For example, to set xhgui to use `Asia/Toyko` timezone for dates: +For example, to set XHGui to use `Asia/Toyko` timezone for dates: - Remove `#ddev-generated` from `.ddev/xhgui/xhgui.config.php` - Change the timezone value From 0dd1a7e303f117cff3e1e90e9c54712afb620650 Mon Sep 17 00:00:00 2001 From: Ralf Koller Date: Wed, 29 Nov 2023 03:13:45 +0100 Subject: [PATCH 2/2] Small refinement to the usage section --- README.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 38cb328..ca1658a 100644 --- a/README.md +++ b/README.md @@ -105,16 +105,10 @@ Profiling in a production environment is not recommended. ``` ## Usage -Make sure your project is started then use the following command to enable profiling. +Run the following commands to enable profiling and then launch the XHGui in your browser. ```shell -ddev xhprof -``` - -Next use the following command to launch the XHGui in your browser: - -```shell -ddev xhgui +ddev xhprof on && ddev xhgui ``` By default, XHGui will be available at `https://yourproject.ddev.site:8143`.