opendev/gerrit
Code Issues Proposed changes

Add caveat about plugin branches in the list of plugins

Browse Source 
In the built version of the documentation that is served by a
running gerrit, the plugin documentaiton links go to the master
branch on gerrit-review.googlesource.com. This isn't immediately
apparent unless the user notices that the URL changed to
gerrit-review and further that master is in the URL and not the
matching stable branch.

Changing all the links to point to the current stable branch is
not feasible. This would mean that we need to update them every
time we make a new stable branch. Also in some cases the plugin
does not actually have the stable branch, so the links would be
broken.

Instead, add a note in the documentation that the links are to
the master branch and the reader should refer to the appropriate
branch for their Gerrit version.

Bug: Issue 11358
Change-Id: Iad9683718a6b130983acd2e8c83b417e4a439d4b
This commit is contained in:
David Pursehouse
2019-09-19 10:11:17 +09:00
parent 8c870b4e5a
commit 95611c4bc3
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/config-plugins.txt
View File

@@ -39,6 +39,10 @@ installed during the link:pgm-init.html[Gerrit initialization].
The core plugins are developed and maintained by the Gerrit maintainers
and the Gerrit community.
Note that the documentation and configuration links in the list below are
to the plugins' master branch. Please refer to the appropriate branch or
revision for the Gerrit version you are using.
[[commit-message-length-validator]]
=== commit-message-length-validator
@@ -130,6 +134,12 @@ list may not be complete. You may discover more plugins on
link:https://gerrit-review.googlesource.com/admin/repos/?filter=plugins%252F[
gerrit-review].
Note that the documentation and configuration links in the list below are
to the plugins' master branch. Please refer to the appropriate branch for
the Gerrit version you are using. Be aware that in some cases a stable
branch might not exist when the master branch is compatible with multiple
versions, or the plugin might not be compatible at all with your version.
[[admin-console]]
=== admin-console