[QPID-8361] [Broker-J] Create a developer guide for Qpid Broker-J

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: qpid-java-broker-8.0.0
• Component/s: Broker-J
• Assignee: Alex Rudyy
• Reporter: Alex Rudyy
• Created: 11/Sep/19 00:40
• Updated: 12/Mar/20 20:20
• Resolved: 19/Feb/20 10:45

Description

The developer documentation is currently scattered over various Qpid confluence pages. It could be challenging for people interested in contributing to the project to find that documentation. A developer guide could be added to cover such aspects as

• Environment Setup
• Building project
• Running tests
• Releasing
• Architecture overview

The following wiki pages are good candidates for inclusion into a developer guide:
High Level Architecture
How To Build Qpid Broker-J
Releasing Qpid Broker-J

The wiki pages below might be included as well
Java Coding Standards
Qpid Java Run Scripts

The developer documentation should be easy to modify, maintain and preview. Thus, it can be written in markdown or asciidoc. The latter is also supported on github.

Potentially, it can be published on Qpid project site as part of release process.

Issue Links

• links to: GitHub Pull Request #36