Fix formatting of documentation Change-Id: I079062823eb8116c272b6148695f901dc3f5473b
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md index 17a4e29..e19d856 100644 --- a/src/main/resources/Documentation/about.md +++ b/src/main/resources/Documentation/about.md
@@ -36,11 +36,11 @@ createdAt = Wed, 13 Nov 2013 14:45:00 +0100 ``` -<a id="createdBy"> +<a id="createdBy"></a> `user.<service-user-name>.createdBy` : The username of the user who created the service user. -<a id="createdAt"> +<a id="createdAt"></a> `user.<service-user-name>.createdAt` : The date when the service user was created.
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index b665fef..aa2e4b5 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -9,7 +9,7 @@ group = Service Users ``` -<a id="block"> +<a id="block"></a> `plugin.@PLUGIN@.block` : A username which is forbidden to be used as name for a service user. The blocked username is case insensitive. The match can @@ -19,28 +19,31 @@ blocked. Multiple usernames can be blocked by specifying multiple `plugin.@PLUGIN@.block` entries. Examples: - [plugin "serviceuser"] - block = johndoe - block = jane* - block = ^gerrit[0-9]* -<a id="group"> +``` + [plugin "serviceuser"] + block = johndoe + block = jane* + block = ^gerrit[0-9]* +``` + +<a id="group"></a> `plugin.@PLUGIN@.group` : The name of an internal group to which newly created service users should be automatically added. Multiple groups can be specified by having multiple `plugin.@PLUGIN@.group` entries. -<a id="infoMessage"> +<a id="infoMessage"></a> `plugin.@PLUGIN@.infoMessage` : HTML formatted message that should be displayed on the service user creation screen. -<a id="onSuccessMessage"> +<a id="onSuccessMessage"></a> `plugin.@PLUGIN@.onSuccessMessage` : Message that should be displayed after a service user was successfully created. -<a id="allowEmail"> +<a id="allowEmail"></a> `plugin.@PLUGIN@.allowEmail` : Whether it is allowed for service user owners to set email addresses for their service users. Independent of this setting @@ -48,7 +51,7 @@ any service user. By default false. -<a id="allowHttpPassword"> +<a id="allowHttpPassword"></a> `plugin.@PLUGIN@.allowHttpPassword` : Whether it is allowed for service user owners to generate HTTP passwords for their service users. Independent of this setting @@ -56,12 +59,12 @@ passwords for any service user. By default false. -<a id="allowOwner"> +<a id="allowOwner"></a> `plugin.@PLUGIN@.allowOwner` : Whether it is allowed to set an owner group for a service user. By default false. -<a id="createNotes"> +<a id="createNotes"></a> `plugin.@PLUGIN@.createNotes` : Whether commits of a service user should be annotated by a Git note that contains information about the current owners of the service @@ -70,7 +73,7 @@ user the 'Forge Committer' access right must be blocked for service users. By default true. -<a id="createNotes"> +<a id="createNotes"></a> `plugin.@PLUGIN@.createNotesAsync` : Whether the Git notes on commits that are pushed by a service user should be created asynchronously. By default false.