opendev/gerrit
Code Issues Proposed changes

Fix formatting issues in 'Plugins source code hosting' documentation

Browse Source 
- The list items under 'Hosting lifecycle' were rendered each in a
  single line, this way readers couldn't distinguish between the heading
  and additional explanation.
- The example given in 'Ideation and discussion' was not rendered as a
  single block but as one block per prargraph.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I40afad9f9ae072c1c2d72a63ba04f1e2cb5ff82e
This commit is contained in:
Edwin Kempin
2019-09-30 13:33:13 +02:00
parent bfa2a6e897
commit a96bbad6df
1 changed files with 46 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
Documentation/dev-plugins.txt
View File

@@ -2873,35 +2873,50 @@ more discoverable and have more chances to be reviewed by the whole community.
The process of writing a new plugin goes through different phases: The process of writing a new plugin goes through different phases:
- Ideation and discussion - Ideation and discussion:
The idea of creating a new plugin is posted and discussed on the +
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss] mailing list. The idea of creating a new plugin is posted and discussed on the
- Prototyping (optional) link:https://groups.google.com/d/forum/repo-discuss[repo-discuss] mailing list.
The author of the plugin creates a working prototype on a public repository
accessible to the community. - Prototyping (optional):
- Proposal and Hosting +
The author proposes to release the plugin under the The author of the plugin creates a working prototype on a public repository
link:https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 OpenSource license] accessible to the community.
and request to be hosted on
link:https://gerrit-review.googlesource.com[the Gerrit project site]. The proposal must be - Proposal and Hosting:
accepted by at least one Gerrit maintainer. In case of disagreement between maintainers, the +
issue can be escalated to the Engineering Steering Committee. If the plugin is accepted, The author proposes to release the plugin under the
the Gerrit maintainer creates the project under the plugins path on link:https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 OpenSource
link:https://gerrit-review.googlesource.com[the Gerrit project site]. license] and request to be hosted on
- Development and contribution link:https://gerrit-review.googlesource.com[the Gerrit project site]. The
The author develops a production-ready code base of the plugin, with contributions, reviews, proposal must be accepted by at least one Gerrit maintainer. In case of
and help from the Gerrit community. disagreement between maintainers, the issue can be escalated to the Engineering
- Release Steering Committee. If the plugin is accepted, the Gerrit maintainer creates
The author releases the plugin by tagging and announcing on the the project under the plugins path on
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss] mailing list. link:https://gerrit-review.googlesource.com[the Gerrit project site].
- Maintenance
The author maintains their plugins as new Gerrit versions are released, updates them when necessary, - Development and contribution:
develops further existing or new features and reviews incoming new contributions. +
A plugin should declare and build on The author develops a production-ready code base of the plugin, with
link:https://gerrit-ci.gerritforge.com[the GerritForge CI] for the Gerrit versions it supports. contributions, reviews, and help from the Gerrit community.
- Deprecation
The author declares that the plugin is not maintained anymore or is deprecated and should - Release:
not be used anymore. +
The author releases the plugin by tagging and announcing on the
link:https://groups.google.com/d/forum/repo-discuss[repo-discuss] mailing list.
- Maintenance:
+
The author maintains their plugins as new Gerrit versions are released, updates
them when necessary, develops further existing or new features and reviews
incoming new contributions. A plugin should declare and build on
link:https://gerrit-ci.gerritforge.com[the GerritForge CI] for the Gerrit
versions it supports.
- Deprecation:
+
The author declares that the plugin is not maintained anymore or is deprecated
and should not be used anymore.
[[ideation_discussion]] [[ideation_discussion]]
=== Ideation and discussion === Ideation and discussion
@@ -2916,6 +2931,7 @@ of the main reasons for starting a new plugin.
Example of a post: Example of a post:
----
[RFC] Code-Formatter plugin [RFC] Code-Formatter plugin
Hello, community, Hello, community,
@@ -2933,6 +2949,7 @@ Example of a post:
to the patchset, highlighting the part of the code to be changed. to the patchset, highlighting the part of the code to be changed.
What do you think? Did anyone have the same idea or need? What do you think? Did anyone have the same idea or need?
----
The idea is discussed on the mailing list and can evolve based on the needs and inputs from The idea is discussed on the mailing list and can evolve based on the needs and inputs from
the entire community. the entire community.