Start a separate documentation page for core plugins
Core plugins are described as part of the plugin config documentation. The purpose of the plugin config documentation is to give an overview of all plugins and which functionality they provide. Defining what core plugins are doesn't really fit into this page. A separate documentation page for core plugins makes sense since we intend to expand this documentation. We want to define more clearly what a core plugin is, what criteria a plugin must fulfill to become a core plugin and processes around core plugins. All this newly planned documentation around core plugins is surely out of scope for the plugin config documentation, hence we want to have a new page for this. Signed-off-by: Edwin Kempin <ekempin@google.com> Change-Id: If6f1867cd4ec0a5843080e094cb397c30af99db8
This commit is contained in:
parent
6072b4b201
commit
ef1b811d6d
@ -37,11 +37,9 @@ branches for old releases.
|
||||
[[core-plugins]]
|
||||
== Core Plugins
|
||||
|
||||
Core plugins are packaged within the Gerrit war file and can easily be
|
||||
installed during the link:pgm-init.html[Gerrit initialization].
|
||||
|
||||
The core plugins are developed and maintained by the Gerrit maintainers
|
||||
and the Gerrit community.
|
||||
link:dev-core-plugins.html[Core plugins] are packaged within the Gerrit
|
||||
war file and can easily be installed during the link:pgm-init.html[
|
||||
Gerrit initialization].
|
||||
|
||||
Note that the documentation and configuration links in the list below are
|
||||
to the plugins' master branch. Please refer to the appropriate branch or
|
||||
|
28
Documentation/dev-core-plugins.txt
Normal file
28
Documentation/dev-core-plugins.txt
Normal file
@ -0,0 +1,28 @@
|
||||
= Gerrit Code Review - Core Plugins
|
||||
|
||||
[[definition]]
|
||||
== What are core plugins?
|
||||
|
||||
Core plugins are plugins that are packaged within the Gerrit war file. This
|
||||
means during the link:pgm-init.html[Gerrit initialization] they can be easily
|
||||
installed without downloading any additional files.
|
||||
|
||||
To make working with core plugins easy, they are linked as
|
||||
link:https://gerrit.googlesource.com/gerrit/+/refs/heads/master/.gitmodules[Git
|
||||
submodules] in the `gerrit` repository. E.g. this means they can be easily
|
||||
link:dev-readme.html#clone[cloned] together with Gerrit.
|
||||
|
||||
The core plugins are developed and maintained by the Gerrit maintainers
|
||||
and the Gerrit community.
|
||||
|
||||
[[list]]
|
||||
== Which core plugins exist?
|
||||
|
||||
See link:config-plugins.html#core-plugins[here].
|
||||
|
||||
GERRIT
|
||||
------
|
||||
Part of link:index.html[Gerrit Code Review]
|
||||
|
||||
SEARCHBOX
|
||||
---------
|
@ -7,7 +7,8 @@
|
||||
The Gerrit project has an engineering steering committee (ESC) that is
|
||||
in charge of:
|
||||
|
||||
* Gerrit core (the `gerrit` project) and the core plugins
|
||||
* Gerrit core (the `gerrit` project) and the link:dev-core-plugins.html[core
|
||||
plugins]
|
||||
* defining the project vision and the project scope
|
||||
* maintaining a roadmap, a release plan and a prioritized backlog
|
||||
* ensuring timely design reviews
|
||||
@ -294,6 +295,11 @@ The ESC should discuss if there are any learnings from the security
|
||||
vulnerability and define action items to follow up in the
|
||||
link:https://bugs.chromium.org/p/gerrit[issue tracker].
|
||||
|
||||
[[core-plugins]]
|
||||
== Core Plugins
|
||||
|
||||
See link:dev-core-plugins.html[here].
|
||||
|
||||
[[upgrading-libraries]]
|
||||
== Upgrading Libraries
|
||||
|
||||
|
@ -5,6 +5,7 @@ compile the code.
|
||||
|
||||
== Git Setup
|
||||
|
||||
[[clone]]
|
||||
=== Getting the Source
|
||||
|
||||
Create a new client workspace:
|
||||
|
Loading…
Reference in New Issue
Block a user