Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 3.03 KB

CONTRIBUTING.adoc

File metadata and controls

50 lines (36 loc) · 3.03 KB
Raw

How to contribute/edit documentation

Thanks for contributing to JBoss Tools Developer documentation.

The layout of the current documentation is the following:

  • building - how to build JBoss Tools and its eclipse plugins

  • debugging - tips’n’tricks on how to best debug

  • issues - how to use issue tracker, shared queries etc.

  • <your topic here> - if you feel an overall issue are missing, create a pull request (PR) and suggest one

To contribute content, you can clone the repository and submit a pull request, or, you can click on the "pencil" icon to make changes directly.

Content guidelines

  • Content should be for how to contribute to or develop JBoss Tools

  • Should not contain user guides for individual plugin functionality unless that guide is likely to be used or extended by many other components. User guides for specific plugins should be placed in each plugin’s documentation folder, or at http://github.com/jbosstools/jbosstools-documentation

  • Use asciidoc (.adoc). See Asciidoc quick reference as a guide to get up to speed with the syntax.

  • If you have existing content that you want to convert to asciidoc, Pandoc works great for almost any reasonable format (especially with this patch applied)

  • use lowercase filenames with underscores in place of a space character. (i.e. how_to_contribute.adoc is good, How-To-Contribute.adoc or howtocontribute.adoc is bad)

GitHub Web vs local/git

There are two recommended ways to contribute to this documentation:

  • using the github web ui

  • offline local editing by cloning the repository.

Almost all features are available in both locations. The main limitation of github’s Web UI is that they currently do not support upload of images. The table below outlines several workflows:

Task local/offline github.com/online

Create text file

git add + commit + push

Click the + icon, name the file and submit

Add image/binary

git add + commit + push

N/A

Edit content

git commit + push

Click the Edit button (appears as a pencil), edit the content, and submit

Delete content

git rm + commit + push

Click the Delete button on the file (appears as a garbage can). http://prose.io/ is an alternative UI that also allows deletes

Notifications

N/A

click Watch repository and you can control the amount of notifications you get

Comments

N/A

use the github issue tracker to ask for clarifications or simply submit suggestions as a pull-request

Note: Everyone can contribute to the documentation, JBoss Tools committers all have push access to this repository. Any non-committers can make edits, which will become pull-requests that any committer can then apply. Even if the edits are not applied directly, your edits will be visible in your fork.