From aeeed9f4fab5edab6513ef1c5210e9a1a4e349e6 Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Sun, 17 Dec 2023 20:26:26 +0100 Subject: [PATCH] Cleanup and improve release notes --- RELEASE_NOTES.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 31f6df9770b..599dcd1e614 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -10,17 +10,17 @@ This serves two purposes: 2. At release time, you can move the Unreleased section changes into a new release version section. ### Added -- Add experimental InMemoryPage::getOutputPath overload support +- Add experimental `InMemoryPage::getOutputPath` overload support ### Changed -- Changed how the documentation search is generated, to be an InMemoryPage instead of a post-build task. -- Updated the documentation article component to support existing $document instance. +- Changed how the documentation search is generated, to be an `InMemoryPage` instead of a post-build task. +- Updated the documentation article component to support existing `$document` instance. ### Deprecated -- \Hyde\Framework\Actions\PostBuildTasks\GenerateSearch +- for soon-to-be removed features. ### Removed -- for now removed features. +- Breaking: Removed the build task `\Hyde\Framework\Actions\PostBuildTasks\GenerateSearch` (see upgrade guide below) ### Fixed - for any bug fixes. @@ -32,23 +32,29 @@ This serves two purposes: If there are any breaking changes, include an upgrade guide here. -#### Documentation search changes +#### Documentation search page changes -The documentation search page and search index have been changed to be generated as InMemoryPages instead of a post-build task. +The documentation search page and search index have been changed to be generated as `InMemoryPages` instead of a post-build task. -In case you have customized the GenerateSearch post-build task, you will need to adapt your code to the new InMemoryPage, which is generated in the HydeCoreExtension class. +The main impact noticeable to most users by this is the implicit changes, like the pages showing up in the dashboard and route list command. + +In case you have customized the `GenerateSearch` post-build task you may, depending on what you were trying to do, +want to adapt your code to interact with the new `InMemoryPage`, which is generated in the `HydeCoreExtension` class. For more information, see https://github.com/hydephp/develop/pull/1498. ### Breaking changes #### Low impact + - The `GenerateSearch` post-build task has been removed. If you have previously extended or customized this class, you will need to adapt your code, as the search index files are now handled implicitly during the standard build process, as the search pages are now added to the kernel page and route collection. (https://github.com/hydephp/develop/pull/1498) + - If your site has a custom documentation search page, for example `_docs/search.md` or `_pages/docs/search.blade.php`, - that page will no longer be build when using the specific `build:search` command. It will, of course, + that page will no longer be built when using the specific `build:search` command. It will, of course, be built using the standard `build` command. https://github.com/hydephp/develop/commit/82dc71f4a0e7b6be7a9f8d822fbebe39d2289ced +- - In the highly unlikely event your site customizes any of the search pages by replacing them in the kernel route collection, you would now need to do that in the kernel page collection due to the search pages being generated earlier in the lifecycle. https://github.com/hydephp/develop/commit/82dc71f4a0e7b6be7a9f8d822fbebe39d2289ced