[ https://issues.apache.org/jira/browse/QPID-8361?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Alex Rudyy updated QPID-8361: ----------------------------- 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|https://cwiki.apache.org/confluence/display/qpid/High+Level+Architecture] [How To Build Qpid Broker-J|https://cwiki.apache.org/confluence/display/qpid/How+To+Build+Qpid+Broker-J] [Releasing Qpid Broker-J|https://cwiki.apache.org/confluence/display/qpid/Releasing+Qpid+Broker-J] The wiki pages below might be included as well [Java Coding Standards|https://cwiki.apache.org/confluence/display/qpid/Java+Coding+Standards] [Qpid Java Run Scripts|https://cwiki.apache.org/confluence/display/qpid/Qpid+Java+Run+Scripts] The developer documentation should be easy to modify, maintain and preview. Thus, it can be written in markdown or [asciidoc|https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/]. The latter is also supported on github. Potentially, it can be published on Qpid project site as part of release process. was: The developer documentation is currently scattered over various Qpid confluence pages. It could be challenging for people interesting 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|https://cwiki.apache.org/confluence/display/qpid/High+Level+Architecture] [How To Build Qpid Broker-J|https://cwiki.apache.org/confluence/display/qpid/How+To+Build+Qpid+Broker-J] [Releasing Qpid Broker-J|https://cwiki.apache.org/confluence/display/qpid/Releasing+Qpid+Broker-J] The wiki pages below might be included as well [Java Coding Standards|https://cwiki.apache.org/confluence/display/qpid/Java+Coding+Standards] [Qpid Java Run Scripts|https://cwiki.apache.org/confluence/display/qpid/Qpid+Java+Run+Scripts] The developer documentation should be easy to modify, maintain and preview. Thus, it can be written in markdown or [asciidoc|https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/]. The latter is also supported on github. Potentially, it can be published on Qpid project site as part of release process. > [Broker-J] Create a developer guide for Qpid Broker-J > ----------------------------------------------------- > > Key: QPID-8361 > URL: https://issues.apache.org/jira/browse/QPID-8361 > Project: Qpid > Issue Type: Task > Components: Broker-J > Reporter: Alex Rudyy > Priority: Major > Fix For: qpid-java-broker-8.0.0 > > > 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|https://cwiki.apache.org/confluence/display/qpid/High+Level+Architecture] > [How To Build Qpid > Broker-J|https://cwiki.apache.org/confluence/display/qpid/How+To+Build+Qpid+Broker-J] > [Releasing Qpid > Broker-J|https://cwiki.apache.org/confluence/display/qpid/Releasing+Qpid+Broker-J] > The wiki pages below might be included as well > [Java Coding > Standards|https://cwiki.apache.org/confluence/display/qpid/Java+Coding+Standards] > [Qpid Java Run > Scripts|https://cwiki.apache.org/confluence/display/qpid/Qpid+Java+Run+Scripts] > The developer documentation should be easy to modify, maintain and preview. > Thus, it can be written in markdown or > [asciidoc|https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/]. The > latter is also supported on github. > Potentially, it can be published on Qpid project site as part of release > process. -- This message was sent by Atlassian Jira (v8.3.2#803003) --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org For additional commands, e-mail: dev-h...@qpid.apache.org