Add config file to describe plugin configuration Change-Id: I6d2d54375c18bc99e4883c2e6f5ff959fd24cc85
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md new file mode 100644 index 0000000..f625682 --- /dev/null +++ b/src/main/resources/Documentation/config.md
@@ -0,0 +1,18 @@ +Configuration +============= + +The configuration of the @PLUGIN@ plugin is done in the `gerrit.config` +file. This plugin overloads Gerrit own DRAFT workflow. The WIP workflow +can only be enabled, when DRAFT workflow in Gerrit was disabled. + +*Warning*: When DRAFT workflow was used in Gerrit, i. e. changes in +status DRAFT still exist, they must be published or deleted before WIP +workflow can be used. + +To disable DRAFT workflow the following must be set in `gerrit.config`: + +``` + [change] + allowDrafts = false +``` +WIP workflow can be used now.