Rundeck docs

NOTE: Documentation process is changing: see https://github.com/rundeck/docs/wiki

Rundeck 2 documentation info below

About

The rundeck docs are stored in the rundeck-docs repository.

Each version is stored in a branch named "docsX.Y"

clone the rundeck-docs repo

git clone git@github.com:dtolabs/rundeck-docs.git

Build the docs zip

In the rundeck source repo:

make -C docs

The result will be in docs/dist/rundeck-docs-X.Y.zip

To update the rundeck-docs repo with a new version

Extract docs and upload new branch:

cd rundeck-docs
sh load.sh path/to/docs/dist/rundeck-docs-X.Y.zip X.Y
git commit -m "Added docs for version X.Y"
git push origin docsX.Y

To update an existing branch with new docs

First checkout the existing branch

git fetch origin docsX.Y
git checkout -t -b docsX.Y origin/docsX.Y

Extract docs and upload new branch, run the load.sh with the --skip option:

cd rundeck-docs
sh load.sh path/to/docs/dist/rundeck-docs-X.Y.zip X.Y --skip
git commit -m "Added docs for version X.Y"
git push origin docsX.Y

Update rundeck.org

Finally, update the rundeck.org site via github pages: Rundeck-site