airship
/
pegleg
Code Issues Proposed changes
A configuration organization tool.
92 Commits 3 Branches 0 Tags 9.9 MiB
Python 98.4%
Shell 0.8%
Makefile 0.8%
Go to file
Felipe Monteiro 33fe583e08 fix: Pegleg exceptions documentation incorrectly rendering 
This patch set changes Pegleg's exceptions documentation
(contained underneath operators guide) because it isn't rendering
correctly as a list table on RTD (the autoexception information
is missing) [0].

The easy fix is to change the tabularized view (list table)
into basically a series of autoexception classes which sufficiently
captures the level of detail required, anyway.

Note that running `tox -e docs` locally and opening the resulting
index.html page appears to work -- but not when hosted on RTD.

[0] https://airship-pegleg.readthedocs.io/en/latest/exceptions.html

Change-Id: Ie4bc01f1fe6aee9b9a58fd956f5b350df44bef51
 		2018-09-25 04:28:47 +00:00
doc fix: Pegleg exceptions documentation incorrectly rendering 2018-09-25 04:28:47 +00:00
images/pegleg Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
pegleg Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
site_yamls/site Check that Pegleg only considers YAML 2018-04-10 08:25:36 -05:00
src/bin/pegleg/pegleg/engine Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
tests Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
tools Merge "docs: Add developer overview guide" 2018-09-14 23:24:05 +00:00
.dockerignore Update to UCP layout standard 2018-03-05 07:42:00 -06:00
.gitignore Allow linting policies to be selectable 2018-03-13 08:57:00 -05:00
.gitreview Update .gitreview for openstack infra 2018-05-17 19:52:49 +01:00
.zuul.yaml Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
README.rst Update Pegleg README 2018-08-29 21:42:04 +00:00
requirements.txt Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
setup.py Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
test-requirements.txt Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
tox.ini Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00

README.rst

Pegleg

Doc Status

Introduction

Pegleg is a document aggregator that provides early linting and validations via Deckhand, a document management micro-service within Airship.

Pegleg supports local and remote Git repositories. Remote repositories can be cloned using a variety of protocols -- HTTP(S) or SSH. Afterward, specific revisions within those repositories can be checked out, their documents aggregated, linted, and passed to the rest of Airship for orchestration, allowing document authors to manage their site definitions using version control.

Find more documentation for Pegleg on Read the Docs.

Core Responsibilities

  • aggregation - Aggregates all documents required for site deployment across multiple Git repositories, each of which can be used to maintain separate document sets in isolation
  • linting - Configurable linting checks documents for common syntactical and semantical mistakes

Getting Started

For more detailed installation and setup information, please refer to the Getting Started guide.

Integration Points

Pegleg has the following integration points:

  • Deckhand which provides document revision management, storage and rendering functionality upon which the rest of the Airship components rely for orchestration of infrastructure provisioning.

Further Reading

Airship.