Fix documentation links Make links render as proper links, remove reference to non-existing config-connectivity document, and add links to all actions. Also use commentlink.link instead of commentlink.html which isn't supported any longer. Change-Id: I276fbfa8385ceacb67297d8c4d2a85f38658477f
diff --git a/src/main/resources/Documentation/config-common.md b/src/main/resources/Documentation/config-common.md index 11c5b58..c8d8339 100644 --- a/src/main/resources/Documentation/config-common.md +++ b/src/main/resources/Documentation/config-common.md
@@ -15,9 +15,9 @@ In order to extract ITS ids from commit messages, @PLUGIN@ uses [commentlink][upstream-comment-link-doc]s of -([per default][common-config-commentlink]) name "`@PLUGIN@`". +([per default](#common-config-commentlink)) name "`@PLUGIN@`". -The ([per default][common-config-commentlinkGroupIndex]) first group of +The ([per default](#common-config-commentlinkGroupIndex)) first group of `commentlink.@PLUGIN@.match` is considered the issue id. So for example having @@ -25,7 +25,7 @@ ```ini [commentlink "@PLUGIN@"] match = [Bb][Uu][Gg][ ]*([1-9][0-9]*) - html = "<a href=\"http://my.issure.tracker.example.org/show_bug.cgi?id=$1\">(bug $1)</a>" + link = http://my.issue.tracker.example.org/show_bug.cgi?id=$1 ``` in `etc/gerrit.config` would allow to match the issues `4711`, `167` @@ -35,7 +35,7 @@ Sample commit message relating to bug 4711, and bug 167. ``` -[upstream-comment-link-doc](../../../Documentation/config-gerrit.html#commentlink) +[upstream-comment-link-doc]: @URL@/Documentation/config-gerrit.html#commentlink By setting a `commentlink`'s `association` on the plugin's @PLUGIN@ configuration, it is possible to require commits to carry ITS references; the following
diff --git a/src/main/resources/Documentation/config-rulebase-common.md b/src/main/resources/Documentation/config-rulebase-common.md index b797d62..dc479a2 100644 --- a/src/main/resources/Documentation/config-rulebase-common.md +++ b/src/main/resources/Documentation/config-rulebase-common.md
@@ -605,24 +605,27 @@ The following actions are available: -[`add-comment`][action-add-comment] +[`add-comment`](#action-add-comment) : adds the parameters as issue comment -[`add-standard-comment`][action-add-standard-comment] +[`add-standard-comment`](#action-add-standard-comment) : adds a predefined standard comment for certain events -[`add-soy-comment`][action-add-soy-comment] +[`add-soy-comment`](#action-add-soy-comment) : adds a rendered Closure Template (soy) template as issue comment -[`create-version-from-property`][action-create-version-from-property] +[`add-property-to-field`](#action-add-property-to-field) +: adds an event property value to an ITS designated field + +[`create-version-from-property`](#action-create-version-from-property) : creates a version based on an event's property value -[`log-event`][action-log-event] +[`fire-event-on-commits`](#action-fire-event-on-commits) +: fires events for a set of commits + +[`log-event`](#action-log-event) : appends the event's properties to Gerrit's log -[Further actions][further-actions] may be provided by @PLUGIN@. - -[further-actions]: config-rulebase-plugin-actions.md ### Action: add-comment
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index 62e398c..8c3c4d5 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -1,15 +1,13 @@ Configuring @PLUGIN@ ==================== -Configuring @PLUGIN@ is a five step process: +Configuring @PLUGIN@ is a four step process: -1. [Set up the ITS connectivity settings][config-connectivity] -2. [Set up the general configuration][config-common] -3. [Set up rule on how/what actions should be taken][config-rulebase-common] -4. Restart gerrit, so the config changes take effect. -5. Install the @PLUGIN@ jar in your gerrit site. +1. [Set up the general configuration][config-common] +2. [Set up rule on how/what actions should be taken][config-rulebase-common] +3. Restart gerrit, so the config changes take effect. +4. Install the @PLUGIN@ jar in your gerrit site. -[config-connectivity]: config-connectivity.md [config-common]: config-common.md [config-rulebase-common]: config-rulebase-common.md