circlecicircleci
834

Circleci Docs

screenshot of Circleci Docs
jekyll

Documentation for CircleCI.

GithubDemo

Overview:

The CircleCI Documentation is a public repository for the CircleCI Docs, a static website generated by Jekyll. It serves as the main source of documentation for CircleCI, housing various components and branches of documentation. Users can contribute to the documentation by submitting issues or pull requests through the Contributing Guide.

Features:

  • Jekyll - Main Site: The main CircleCI documentation site built with Jekyll, containing the majority of the documentation. It integrates other branches of documentation into the site during the build process.
  • src-api - API v1.1 and v2 Build Tooling: This component includes the API documentation source for API v1 and v2. API v1 is manually written and compiled to work with Slate, while API v2 is compiled from an OpenAPI spec using Redoc.
  • Testing Checklist: A checklist for testing is available within the confluence space to provide more flexibility for users.

Summary:

The CircleCI Documentation repository serves as the central hub for CircleCI's documentation. It consists of the main site built with Jekyll, API documentation for v1 and v2, and a checklist for testing. Users can contribute by making changes to the relevant components and following the Contributing Guide. The documentation is licensed under Creative Commons Attribution-NonCommercial-ShareAlike CC BY-NC-SA and MIT license for different components.

jekyll
Jekyll

Jekyll is a static site generator written in Ruby that allows you to create simple, fast, and secure websites without the need for a database.

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.

gulp
Gulp

Gulp.js is an old but popular site building tool that automates various repetitive development tasks in web development, such as compiling Sass, minifying JavaScript, and optimizing images.