Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JBIDE-23012 this project is deprecated. Link... #264

Merged
merged 1 commit into from Aug 26, 2016
Merged

JBIDE-23012 this project is deprecated. Link... #264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
81 changes: 4 additions & 77 deletions README.md
View file
Open in desktop
Expand Up @@ -2,81 +2,8 @@

## Summary

JBoss Tools Documentation contains various docs and Whats New and Noteworthy for JBoss Tools
JBoss Tools Documentation is deprecated. Content is now located elsewhere:

## Install

_Jboss Tools Documentation_ is part of [JBoss Tools](http://jboss.org/tools) from
which it can be [downloaded and installed](http://jboss.org/tools/download)
on its own or together with the full JBoss Tools distribution.

## Get the code

The easiest way to get started with the code is to [create your own fork](http://help.github.com/forking/),
and then clone your fork:

$ git clone git@github.com:<you>/jbosstools-documentation.git
$ cd jbosstools-documentation
$ git remote add upstream git://github.com/jbosstools/jbosstools-documentation.git

At any time, you can pull changes from the upstream and merge them onto your master:

$ git checkout master # switches to the 'master' branch
$ git pull upstream master # fetches all 'upstream' changes and merges 'upstream/master' onto your 'master' branch
$ git push origin # pushes all the updates to your fork, which should be in-sync with 'upstream'

The general idea is to keep your 'master' branch in-sync with the
'upstream/master'.

## Building Jboss Tools Documentation

To build _Jboss Tools Documentation_ requires specific versions of Java and
Maven. Also, there is some Maven setup. The [How to Build JBoss Tools with Maven 3](https://community.jboss.org/wiki/HowToBuildJBossToolsWithMaven3)
document will guide you through that setup.

This command will run the build:

$ mvn clean verify

If you just want to check if things compiles/builds you can run:

$ mvn clean verify -DskipTest=true

But *do not* push changes without having the new and existing unit tests pass!

## Contribute fixes and features

_Jboss Tools Documentation_ is open source, and we welcome anybody that wants to
participate and contribute!

If you want to fix a bug or make any changes, please log an issue in
the [JBoss Tools JIRA](https://issues.jboss.org/browse/JBIDE)
describing the bug or new feature and give it a component type of
`documentation`. Then we highly recommend making the changes on a
topic branch named with the JIRA issue number. For example, this
command creates a branch for the JBIDE-1234 issue:

$ git checkout -b jbide-1234

After you're happy with your changes and a full build (with unit
tests) runs successfully, commit your changes on your topic branch
(with good comments). Then it's time to check for any recent changes
that were made in the official repository:

$ git checkout master # switches to the 'master' branch
$ git pull upstream master # fetches all 'upstream' changes and merges 'upstream/master' onto your 'master' branch
$ git checkout jbide-1234 # switches to your topic branch
$ git rebase master # reapplies your changes on top of the latest in master
(i.e., the latest from master will be the new base for your changes)

If the pull grabbed a lot of changes, you should rerun your build with
tests enabled to make sure your changes are still good.

You can then push your topic branch and its changes into your public fork repository:

$ git push origin jbide-1234 # pushes your topic branch into your public fork of Jboss Tools Documentation

And then [generate a pull-request](http://help.github.com/pull-requests/) where we can
review the proposed changes, comment on them, discuss them with you,
and if everything is good merge the changes right into the official
repository.
* [New and Noteworthy](https://github.com/jbosstools/jbosstools-website/tree/master/documentation/whatsnew)
* [N&N JIRA creator script](https://github.com/jbosstools/jbosstools-build-ci/blob/jbosstools-4.4.x/util/createnewandnoteworthy.py)
* [Other Documentation](https://github.com/jbosstools/jbosstools-website/tree/master/documentation)