Home

(WIP)

This is to document the new (5/2018) Rundeck Documentation project.

• New Documentation Source repo: https://github.com/rundeck/docs
• Existing generated docs repo: https://github.com/rundeck/rundeck-docs
• Existing rundeck.org site repo: https://github.com/rundeck/rundeck-org-site

Note: previous (<5/2018) Rundeck Docs info: https://github.com/rundeck/rundeck/wiki/Rundeck-docs

Goals

• use a separate repo for documentation source
• seamless transition from old documentation build/publish to new repo
• include Rundeck PRO documentation within the source base
• track Rundeck OSS/PRO release identification along with documentation

Side effects

• rundeck OSS release process inclusion of changelog in generated documentation will be removed

Workflow

Development:

• Rundeck OSS/Pro releases are 1:1 synched: OSS version vX.Y.Z tracks PRO version vQ.R.S
• rundeck/docs repo has separate branch for each minor OSS release #.#.x
• documentation for release vX.Y.Z OSS is added to branch X.Y.x
• release of OSS vX.Y.Z will tag branch X.Y.x with tag "vX.Y.Z"
• additional Branch information: Branches

Build:

• using existing build mechanism from OSS (makefile/pandoc/edam.groovy)

Release:

(implemented in ci-deploy.sh script)

• Rundeck OSS vX.Y.Z or PRO vQ.R.S is released and tagged
• documentation branch X.Y.x is tagged with "vX.Y.Z"
• tagged branch is used to generate HTML documentation
• generated docs repo rundeck/rundeck-docs cloned, and new branch "docsX.Y.Z" created, HTML content committed and pushed
• rundeck-org site repo rundeck/rundeck-org-site cloned
  • new git submodule "X.Y.Z" created pointing at rundeck/[email protected]
  • new git submodule "proQ.R.S" created pointing at same location
• IF this release is not a maintenance release
  • git submodule "docs" is updated to point to same location

Progress

• new repo created
• existing docs imported
• new process added to publish docs from new repo
• old docs removed from rundeck/rundeck
• old release process changed to not update rundeck/rundeck/docs
• streamline maintenance of docs, see Branches