Merge branch 'stable-3.1' * stable-3.1: Documentation: Fix parentForDeletedProjects in config.md Adapt the change in Gerrit core Bump Bazel version to 2.2.0 Bump required Bazel version to 2.1.0 Upgrade bazlets to latest stable-2.16 to build with 2.16.16 API Documentation: Refactor to match other plugin documentation Add an empty tools/BUILD file explicitly for Bazel Upgrade bazlets to latest stable-2.16 Upgrade bazlets to latest stable-2.16 Upgrade bazlets to latest stable-2.15 Upgrade bazlets to latest stable-2.14 config.md: Correct formatting of config values Change-Id: Ib51ef5f829d0b318cffc41c44f83eb56e55a53df
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index 01c756b..4b5f6f2 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -7,10 +7,10 @@ ``` [plugin "@PLUGIN@"] allowDeletionOfReposWithTags = true + ``` -<a id="allowDeletionOfReposWithTags"> -`plugin.@PLUGIN@.allowDeletionOfReposWithTags` +plugin.@PLUGIN@.allowDeletionOfReposWithTags : Whether repositories that contain tags can be deleted. In some organizations repositories that contain tags must not be @@ -21,8 +21,7 @@ By default true. -<a id="hideProjectOnPreserve"> -`plugin.@PLUGIN@.hideProjectOnPreserve` +plugin.@PLUGIN@.hideProjectOnPreserve : Whether projects should be hidden when the preserve option is used for the deletion. @@ -34,8 +33,7 @@ By default false. -<a id="parentForDeletedProjects"> -`plugin.@PLUGIN@.parentForDeletedProjects` +plugin.@PLUGIN@.parentForDeletedProjects : The name of the project that is used as parent for all deleted projects that were preserved by hiding them. @@ -44,8 +42,7 @@ By default `Deleted-Projects`. -<a id="protectedProject"> -`plugin.@PLUGIN@.protectedProject` +plugin.@PLUGIN@.protectedProject : The name of a project that is protected against deletion. May be an exact name or a regular expression. @@ -54,8 +51,8 @@ By default not set. -<a id="archiveDeletedRepos"> -`plugin.@PLUGIN@.archiveDeletedRepos` + +plugin.@PLUGIN@.archiveDeletedRepos : Whether to archive repositories instead of deleting them. Archiving the git repository means that the repository is stored @@ -79,8 +76,7 @@ By default false. -<a id="archiveFolder"> -`plugin.@PLUGIN@.archiveFolder` +plugin.@PLUGIN@.archiveFolder : The absolute path of the archive folder to store archived repositories. The git repository is archived to this target folder only if @@ -88,8 +84,7 @@ By default `$site_path/data/delete-project`. -<a id="deleteArchivedReposAfter"> -`plugin.@PLUGIN@.deleteArchivedReposAfter` +plugin.@PLUGIN@.deleteArchivedReposAfter : The time duration for the git repository to be archived. The following suffixes are supported to define the time unit:\n