diff --git a/docs/upgrade-collector.adoc b/docs/upgrade-collector.adoc index e18f824..dc85871 100644 --- a/docs/upgrade-collector.adoc +++ b/docs/upgrade-collector.adoc @@ -18,13 +18,23 @@ This document explains what is needed to move from lib-explorer-4.0.0 (and app-explorer-4.0.0) requires xpVersion=7.12.2 -See <>. +.gradle.properties +[source,properties] +---- +xpVersion=7.12.2 +---- ==== build.gradle In build.gradle you have to bump lib-explorer version to 4.0.0. -See <>. +.build.gradle +[source,groovy] +---- +dependencies { + include "com.enonic.lib:lib-explorer:4.x.x" +} +---- == Installation @@ -32,7 +42,7 @@ See <>. Collectors are now supposed to provide their own documentTypes. -See <>. +See https://developer.enonic.com/docs/collector/stable/doctype[Managed document types]. === Deprecations @@ -102,7 +112,7 @@ This prop is untouched: * [green]*explorer* (object) -See <>. +See https://developer.enonic.com/docs/collector/stable/form[Collector form]. == Run @@ -113,13 +123,13 @@ See <>. * [red]*name* has been replaced by [lime]*collectionId*. * [lime]*language* has been added. -See <>. +See https://developer.enonic.com/docs/collector/stable/task#task_schema[Task schema]. ==== Journal collector.addSuccess() and collector.addError() no longer takes an uri parameter. -See <>. +See <>, <>, <> and <>. ==== persistDocument @@ -128,11 +138,11 @@ See <>. Since collectors now provide their own document-types, you also have to specify *documentTypeName* when persisting a document. Just make sure it matches a (lowercased and ascii folded) _name in the src/main/resources/documentTypes.json file. -See <>. +See <>. ===== update Since [red]*uri* is no longer a required parameter to persistDocument, there is no way for a collector instance to automatically figure out which document node to *update*. If you want to *update* a document, rather than creating endless new ones, you have to lookup and provide the document node [lime]*_id* in your collector task implementation. -See <>. +See <> and <>.