screwdriver-cdscrewdriver-cd
145

Guide

screenshot of Guide
mkdocs

Screwdriver.cd Documentation

GithubDemo

Overview:

Screwdriver is a self-contained, pluggable service designed to assist in building, testing, and continuously delivering software using the latest containerization technologies. It provides a guide powered by Jekyll for users to understand and contribute to the Screwdriver CD service.

Features:

  • Self-contained Service: Screwdriver offers a self-contained and pluggable service for building, testing, and continuous delivery of software.
  • Powered by Jekyll: The guide is powered by Jekyll, allowing for easy access and contribution.
  • Support for Latest Technologies: Screwdriver incorporates the use of containerization technologies to streamline software development processes.
  • Easy to Install: Users can choose to run Jekyll using Docker or by direct installation, making it accessible to a wide range of developers.

Running Jekyll using Docker:

  1. Install Docker Desktop if not already installed.
  2. Ensure Docker is running by checking with docker info. On Mac, you can launch Docker easily with open -a /Applications/Docker.app/.
  3. Run the Jekyll Docker image with a mount of $PWD to its serving location and with -ti. Use the command: docker run -v "$PWD":/srv/jekyll -ti jekyll/jekyll jekyll serve.

Running Jekyll by Installing:

  1. Make sure you have Ruby, RubyGems, and bundler installed.
  2. Check if Ruby is installed (version 2.1 or above).
  3. Install Jekyll using bundler by running: bundle install.
  4. Run the Jekyll server with the command: bundle exec jekyll serve.

Viewing Docs Locally:

  1. Locate the _config.yml file and the docs folder for documentation source files.
  2. Preview the documentation locally using the Jekyll built-in webserver. Run: bundle exec jekyll serve --source docs --destination _site.

Building and Viewing Using Docker:

  1. From the root directory of the repository, execute the Docker command to build and view the Screwdriver Guide using Docker.
  2. Once the webserver is running, open http://127.0.0.1:4000/ in a browser to view the guide.

Summary:

Screwdriver is a versatile service that simplifies the process of software development through its self-contained, pluggable nature. By offering an intuitive guide powered by Jekyll, developers can conveniently access resources and contribute effectively. The flexibility to run Jekyll either through Docker or direct installation ensures accessibility for developers with varying preferences.

mkdocs
MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

documentation
Documentation

Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.