incubator-bloodhound-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Apache Bloodhound" <bloodhound-...@incubator.apache.org>
Subject [Apache Bloodhound] Proposals/BEP-0005 added
Date Wed, 23 Jan 2013 21:14:28 GMT
Page "Proposals/BEP-0005" was added by olemis
Comment: [BEP-0005] Initial version with correct headers
Content:
-------8<------8<------8<------8<------8<------8<------8<------8<--------

= BEP 5 : Plugin upgrades #overview

[[PageOutline]]

|| '''BEP''' || 5 ||
|| '''Title''' || Plugin upgrade facility ||
|| '''Version''' ||  ||
|| '''Last-Modified''' ||  ||
|| '''Author''' || José Angel Franco Navarro <jangel.franco@gmail.com> ||
|| '''Status''' || Draft ||
|| '''Type''' || Standards Track ||
|| '''Content-Type''' || [wiki:PageTemplates/Proposals text/x-trac-wiki] ||
|| '''Created''' ||  ||
|| '''Post-History''' ||  ||

----

== Abstract #abstract

<Delete text in this section and add a short (~200 word) description of the technical issue
being addressed. Take a look at sample abstract below>

This template provides a boilerplate or sample template for creating your
own BEPs.  In conjunction with the [wiki:/Proposals general content guidelines] and the [wiki:/Proposals/Formats/WikiFormatting
WikiFormatting BEP guidelines]  
, this should make it easy for you to conform your own
BEPs to the format outlined below. See [#howto How to Use This Template] for further instructions.

**Note**: if you are reading this template via the web, you should first try to create a new
wiki page by selecting `ProposalsRst` |page template guide|.  **DO NOT EDIT THIS WIKI PAGE
IN ORDER TO CREATE A NEW BEP! **

If you would prefer not to use WikiFormatting markup in your BEP, please see  [wiki:/Proposals/Formats/RestructuredText
reStructuredText BEP guidelines].

== Motivation ==

<The motivation is critical for BEPs that want to change the copy of ''Trac'' patched using
vendor branch . It should clearly explain why the existing ''Bloodhound'' solution is inadequate
to address the problem that the ''BEP'' solves. ''BEP'' submissions without sufficient motivation
may be rejected outright. >

== Proposal #proposal

<The technical specification should describe any new features , detail its impact on the
components architecture , mention what plugins will be included as a result , whether they
are hosted by ​[http://trac-hacks.org trac-hacks.org] or not , and any other relevant technical
subject . The specification should be detailed enough to allow competing, interoperable implementations
for any of the current supported database platforms (e.g. ''SQLite'', ''Postgres'', ''MySQL'')
and server technologies (e.g. ''Apache HTTPD server'', ''nginx'', ''mod_wsgi'', ''CGI'')..
>

== Rationale #rationale

<The rationale fleshes out the specification by describing what motivated the design and
why particular design decisions were made. It should describe alternate designs that were
considered and related work, e.g. how the feature is supported in other issue trackers or
''Trac'' hacks . The rationale should provide evidence of consensus within the community and
discuss important objections or concerns raised during discussion. Take a look at sample rationale
below>

''BEP'' submissions come in a wide variety of forms, not all adhering to the format guidelines
set forth below. Use this template, in conjunction with the [wiki:/Proposals general content
guidelines] and the [wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines],
to ensure that your ''BEP'' submission is easy to read and understand.

This template allows to create BEPs and is very similar to [http://www.python.org/dev/peps/pep-0012
PEP 12] . However it has been optimized by moving long explanations to the [wiki:/Proposals/Formats/WikiFormatting
WikiFormatting BEP guidelines] . If you are interested take a look at the  [?action=diff&old_version=1
differences]. The goal is to redact new BEPs just by following in-line instructions between
angle brackets (i.e. **<** **>**) . Even if this will allow to write BEPs faster , it
is highly recommended to read the [wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP
guidelines] at least once in your lifetime to be aware of good practices and expected style
rules . 

== How to Use This Template #howto

<BEPs may include further sections. This is an example.>

Quick edits will consist in following the instructions inside angle brackets (i.e. **<**
**>**) . That should be everything needed to write new BEPs. To be more informed about
advanced considerations please read the [wiki:/Proposals general content guidelines] and the
[wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines] . If there is no point
in including one of the sections in this document then feel free to remove it.

== Backwards Compatibility #backwards-compatibility

<All BEPs that introduce backwards incompatibilities must include a section describing
these incompatibilities and their severity. The ''BEP'' must explain how to deal with these
incompatibilities. ''BEP'' submissions without a sufficient backwards compatibility treatise
may be rejected outright. >

== Reference Implementation #reference-implementation

< The reference implementation **must** be completed before any ''BEP'' is given status
**Final**, but it need not be completed before the ''BEP'' is accepted. It is better to finish
the specification and rationale first and reach consensus on it before writing code. The final
implementation **must** include test code and documentation appropriate for either the wiki
pages in ''Bloodhound'' users guide or an specific wiki page in the [http://issues.apache.org/bloodhound
​issue tracker] . >

== Resources #resources

<Provide links to useful resources related to the subject discussed. See sample text below>

See WikiFormatting for more help on the markup used to write wiki pages.

== References #references

<List the references included in BEP body>

  1. PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton
     http://www.python.org/dev/peps/pep-0001/
  2. PEP 9, Sample Plaintext PEP Template, Warsaw
     http://www.python.org/dev/peps/pep-0009
  2. PEP 12, Sample reStructuredText ''PEP'' Template, Goodger, Warsaw
     http://www.python.org/dev/peps/pep-0012/
  3. http://www.opencontent.org/openpub/

== Copyright #copyright

<In this section all licensing issues should be meticulously exposed . Library and plugin
dependencies are among the most important topics . On the other hand each BEP will be explicitly
labelled with a copyright statement like shown below, so should not change that. Requests
for a different copyright statement have to be posted to bloodhound-dev@incubator.apache.org
. For more details consult [wiki:/Proposals#what-belongs-in-a-successful-bep BEP structure
explained] .>

Copyright © 2009-2012 The [http://www.apache.org Apache Software Foundation] [[BR]] 
Licensed under the [http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0].

Apache Bloodhound, Apache, the Apache feather logo, and the Apache Bloodhound project logo
are trademarks of The Apache Software Foundation.

-------8<------8<------8<------8<------8<------8<------8<------8<--------

--
Page URL: <https://issues.apache.org/bloodhound/wiki/Proposals/BEP-0005>
Apache Bloodhound <https://issues.apache.org/bloodhound/>
The Apache Bloodhound (incubating) issue tracker

This is an automated message. Someone added your email address to be
notified of changes on 'Proposals/BEP-0005' page.
If it was not you, please report to .

Mime
View raw message