Skip to content

Latest commit

 

History

History
121 lines (62 loc) · 4.26 KB

CONTRIBUTING.md

File metadata and controls

121 lines (62 loc) · 4.26 KB

Hacking on the JDF site

Basic Steps

To contribute to the jdf-site, fork the jdf-site repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git.

  2. Clone your fork. This creates a directory in your local file system.

     git clone [email protected]:<your-username>/jdf-site.git

  3. Add the remote upstream repository.

     git remote add upstream [email protected]:jboss-jdf/jdf-site.git

  4. Get the latest files from the upstream repository.

     git fetch upstream

  5. Import the examples/ticket-monster, migrations/seam2, quickstarts/jboss-as-quickstart, quickstarts/qstools, stack/plugin-jdf, and stack/stacks-client submodules.

     git submodule update --init --recursive

  6. Create a new topic branch to contain your features, changes, or fixes.

     git checkout -b <topic-branch-name> upstream/master

  7. Contribute new code or make changes to existing files.

  8. Test your changes to the site. See Running the site locally or Running the site on Sandbox below for instructions.

  9. Commit your changes to your local topic branch. You must use git add filename for every file you create or change.

     git add <changed-filename>
 git commit -m `Description of change...`

  10. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

    git push origin HEAD

  11. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

Set up your environment

The JDF site is built using awestruct, and requires a number of gems and eggs, as well as AsciiDoc (8.6.x).

To setup the environment you need to follow these steps. Certify to use the correct versions.

  1. Install Ruby 1.9.X

    For RHEL you can use this spec

  2. Install Ruby GEMs. If the version is noted, you must use that version.

     gem install rake bundle
 rake setup

  3. JDF site uses Github API to obtain some data. Due to Github Rate Limiting, it's required that you create a file $HOME/.github-auth containing username:password on one line.

Running the site locally

Having got your environment correctly set up, on jdf-site root, run:

  rake

to run awestruct in development mode, and serve the site at http://localhost:4242.

Publishing the site on Sandbox

  1. Contact the project lead, and ask for access to the jdf account on OpenShift. Add your ssh key.

  2. Run ./publish.sh -d

  3. The site will be available at http://site-jdf.rhcloud.com, which we use as sandbox, for developing new features and sections for the site.

Staging changes

  1. Contact the project lead, and ask for access to filemgmt.jboss.org.

  2. Run ./publish.sh -s

  3. The site will be available at http://jboss.org/jdf/stage, which use for staging changes to the site. Stage is normally reserved for verifying minor updates to the site, or for final verification before a major update.

Publishing on Production

  1. Make sure you have Sendmail installed and running. Sendmail will be used to send mail notifications.

On Linux you can install sendmail running: sudo yum install sendmail.

  1. Contact the project lead, and ask for access to filemgmt.jboss.org.

  2. Update the site version on `_config/site.yml' -

  3. Run ./publish.sh -p

  4. The site will be available at http://jboss.org/jdf, the production site.

NOTE: You can also run:

./release.sh -s <old snapshot version> -r <release version>

This will update the version number (step 3), commit and tag and publish the site to http://jboss.org/jdf (step 4). Then it will reset the version number back to the snapshot version number.