You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by fc...@apache.org on 2013/01/03 10:56:30 UTC
svn commit: r1428250 - /stanbol/site/trunk/content/development/index.mdtext
Author: fchrist
Date: Thu Jan 3 09:56:29 2013
New Revision: 1428250
URL: http://svn.apache.org/viewvc?rev=1428250&view=rev
Log:
Updated development page
Modified:
stanbol/site/trunk/content/development/index.mdtext
Modified: stanbol/site/trunk/content/development/index.mdtext
URL: http://svn.apache.org/viewvc/stanbol/site/trunk/content/development/index.mdtext?rev=1428250&r1=1428249&r2=1428250&view=diff
==============================================================================
--- stanbol/site/trunk/content/development/index.mdtext (original)
+++ stanbol/site/trunk/content/development/index.mdtext Thu Jan 3 09:56:29 2013
@@ -1,7 +1,20 @@
Title: Development
-This site documents development related issues when working with the
-Apache Stanbol source code and contributing to it.
+This site documents development related issues when working with the Apache Stanbol source code and contributing to it.
+
+Everything has to be discussed on the developer [mailing list](#mailing_lists) prior to any
+implementation action. If it is not on the list, it did not happen.
+
+New features should be backed by [JIRA issues](#issue_tracking) that describe the goals,
+use cases and software design decisions, which are usually the result
+of dev list discussions. It is much easier to refer to JIRA issues describing
+the implementation details for further discussions and later reference.
+
+The developers list is not a good place for persistent information, but JIRA issues
+can also be used as an initial form of [documentation](#documentation) for new
+features: add usage and test instructions to the JIRA issues once your features
+reaches a usable state, so that others can test them. This is a good way of
+evolving the features documentation, as you work on the implementation.
<a name="mailing_lists"></a>
## Mailing Lists
@@ -82,26 +95,12 @@ followed by the Apache Stanbol project.
* [Security Aware Coding](security.html)
* [Release Management](release-management.html)
-## Discussions, Decisions and Tracking new Features
-
-Everything has to be discussed on the developer [mailing list](#mailing_lists) prior to any
-implementation action. If it is not on the list, it did not happen.
-
-New features should be backed by JIRA issues that describe the goals,
-use cases and software design decisions, which are usually the result
-of dev list discussions. It is much easier to refer to JIRA issues describing
-the implementation details for further discussions and later reference.
-
-The dev list is not a good place for persistent information, but JIRA issues
-can also be used as an initial form of documentation for new
-features: add usage and test instructions to the JIRA issues once your features
-reaches a usable state, so that others can test them. This is a good way of
-evolving the features documentation, as you work on the implementation.
-
+<a name="documentation"></a>
## Documentation
-As mentioned below, starting with JIRA issues that describe what you're doing and
+
+For a first documentation starting with JIRA issues that describe what you're doing and
how to use and test it is often good enough, and it's a good way to document things
as you go.
-Once new features reach a somewhat stable state, it's good to document them on
-the website. See [Website Development](website.html) for more info.
\ No newline at end of file
+Once new features reach a somewhat stable state, it's good to
+[document them on the website](website.html).
\ No newline at end of file