Screwdriver Guide is the documentation repository for Screwdriver.cd, a continuous delivery platform built as a self-contained, pluggable service for building, testing, and delivering software using containerization technologies.
The guide serves as the central reference for users and contributors to understand and work with Screwdriver. It addresses the need for comprehensive, accessible documentation by hosting it in a Jekyll-based site that can be browsed locally or deployed online. The documentation is organized in markdown files within a docs folder, with navigation structure defined in a menu configuration file, allowing contributors to add new documentation by simply creating markdown files and updating the menu hierarchy.
The guide suits teams already using or evaluating Screwdriver who need reference material for implementation and contribution. It is particularly valuable for contributors looking to understand how to participate in the project's development. The repository provides flexibility in how documentation is built and served, supporting both Docker-based and local Ruby installation approaches, which accommodates different developer environments and preferences.
The project maintains active documentation updates with straightforward contribution workflows that do not require complex tooling beyond standard markdown editing. The Jekyll-based approach keeps the documentation lightweight and version-controllable alongside the main codebase, and the support for multiple language versions indicates ongoing internationalization efforts to reach a broader audience.
