diff --git a/docs/extending/README.md b/docs/extending/README.md index 082fe0e56..383432884 100644 --- a/docs/extending/README.md +++ b/docs/extending/README.md @@ -22,5 +22,3 @@ Learn how to extend the features of the Alfresco Content Application. - [Creating custom evaluators](/extending/creating-custom-evaluators) - [Custom extension loaders](/extending/custom-extension-loaders) - [Redistributable libraries](/extending/redistributable-libraries) -- [Application Hook](/extending/application-hook) -- [Tutorials](/../tutorials/) diff --git a/docs/features/README.md b/docs/features/README.md index 7f9bc7d3e..9d58333cb 100644 --- a/docs/features/README.md +++ b/docs/features/README.md @@ -25,3 +25,4 @@ This application simplifies the complexity of Content Management and provides co - [Version Manager](/features/version-manager) - [Search results](/features/search-results) - [Search forms](/features/search-forms) +- [Application Hook](/extending/application-hook) diff --git a/docs/images/search-layout-2.5.0.png b/docs/images/search-layout-2.5.0.png new file mode 100644 index 000000000..856e42361 Binary files /dev/null and b/docs/images/search-layout-2.5.0.png differ diff --git a/docs/toc.md b/docs/toc.md index 3c5546db9..8517bb8ff 100644 --- a/docs/toc.md +++ b/docs/toc.md @@ -41,4 +41,6 @@ - [How to extend File lists](/tutorials/file-lists) - [How to extend File Preview](/tutorials/file-preview) - [How to extend The Search Form](/tutorials/search-form) +- [Upgrade guide](/upgrade-guide/) + - [Upgrade from v2.4.0 to v2.5.0](/upgrade-guide/upgrade24-45) - [Get help](/help) diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md index 7d70815d4..8d92b7ecf 100644 --- a/docs/tutorials/README.md +++ b/docs/tutorials/README.md @@ -20,3 +20,4 @@ Learn more about developing with the Alfresco Content Application. - [File Lists](/tutorials/file-lists) - [Search Form](/tutorials/search-form) - [Content Metadata](/tutorials/content-metadata) +- [Application Hook](/extending/application-hook) diff --git a/docs/extending/application-hook.md b/docs/tutorials/application-hook.md similarity index 100% rename from docs/extending/application-hook.md rename to docs/tutorials/application-hook.md diff --git a/docs/upgrade-guide/README.md b/docs/upgrade-guide/README.md new file mode 100644 index 000000000..b06967f81 --- /dev/null +++ b/docs/upgrade-guide/README.md @@ -0,0 +1,12 @@ +--- +Title: Upgrade guides +Github only: true +--- + +# Upgrade guides + +Below are links to the upgrade guides notes for released versions + +## Contents + +- [Upgrade from v2.4.o to v2.5.0](/upgrade-guide/upgrade24-45) diff --git a/docs/upgrade-guide/upgrade24-45.md b/docs/upgrade-guide/upgrade24-45.md new file mode 100644 index 000000000..8f9ad1071 --- /dev/null +++ b/docs/upgrade-guide/upgrade24-45.md @@ -0,0 +1,36 @@ +--- +Title: Upgrade from v2.4.0 to v2.5.0 +Github only: true +--- + +# Upgrade from v2.4.0 to v2.5.0 + +This guide explains how to upgrade your ACA v2.4.0 project to work with v2.5.0. + +Do not skip this task, if you want your application to be updated to a most recent version of ACA. +Upgrades of multiple versions of ACA cannot be done in one step only, but should follow the chain of sequential updates. + +**Note:** the steps described below might involve making changes +to your code. If you are working with a versioning system then you should +commit any changes you are currently working on. If you aren't using versioning +then be sure to make a backup copy of your project before going ahead with the +upgrade. + +### Search Forms +We released a new feature called search forms. It would allow the user to set up numerous search configurations, and it could be extended from the extension. + +![](../images/search-layout-2.5.0.png) + +We moved the search object to [`app.extension.json`](https://github.com/Alfresco/alfresco-content-app/blob/v2.5.0/src/assets/app.extensions.json#L1181) from [`app.config.json`](https://github.com/Alfresco/alfresco-content-app/blob/v2.4.0/src/app.config.json#L192) in order to enable extendable search forms. + +#### How to opt to this? + If you don't have any search override, you can just remove the [`search`](https://github.com/Alfresco/alfresco-content-app/blob/v2.4.0/src/app.config.json#L192) configuration from app.config.json + +#### What if search configuration is customised? + The customised configuration should be moved to the custom extension own by you. [check here](/tutorials/search-form) + +#### How can I know if search setup is customised? + Just compare your app.config search object with [old configuration](https://github.com/Alfresco/alfresco-content-app/blob/v2.4.0/src/app.config.json#L192) + +### See also + - [How to extend The Search Form](/tutorials/search-form)