Community
|
|
||||
|
|
||||
- Community
- Collaboration
- Testing development releases
- Submitting patches
- Forums
- Using the Forums
- Mailing Lists
- Subscribing to Mailing Lists
- Wiki
- Writing or Editing Wiki Articles
- Contribute Code
- Documentation
- Documentation: Contribute New Material
- Join a project team
- Issue Tracking
- Submitting bug reports and submitting feature requests
- Help and Information
- Community Structure
Documentation
JBoss projects aim to deliver at a minimum the following documents together with each General Availability (GA) release:
- Javadoc for the public API
- Reference Guide
Where possible, Getting Started Guides or User Guides are also provided to ensure that users can get up to speed quickly and use the software productively.
To see the documentation available for each project you can either use the Documentation portlet on the Resources page or simply visit the project's main page.
Creating Documentation
All JBoss documentation is created using DocBook so that it can easily be presented in different formats or styles. For example we typically produce single-page HTML, multiple-page HTML and PDF formats of the Reference Guides available at JBoss.org. Different styles are used to make the material more attractive or to highlight new releases.
Since documentation needs to be developed in a structured way, to coincide with each product release, it is stored in a version control repository. This means that to make a contribution to a document you need to submit a patch. If you submit a substantial number of patches, or you create a particularly useful piece of documentation, then you may be offered commit access to the repository to make your own changes.
Note that this method of contribution is different from using the wiki, which typically contains information about products discovered after their release and can be edited by anyone with a jboss.com account.