A configuration organization tool.
31e5b898a2
Readthedocs failed to render Pegleg exceptions with error: > WARNING: autodoc: failed to import exception ... from module > 'pegleg'; the following exception was raised: No module named 'click' Trying to add Pegleg requirements to the installed requirements list, so that Readthedocs has all modules, including those needed for the Pegleg itself. Change-Id: I1780a9be3aeb0c3e2e775cbb1f713c2033f13e08 |
||
|---|---|---|
| doc | ||
| images/pegleg | ||
| pegleg | ||
| releasenotes | ||
| site_yamls/site | ||
| tests | ||
| tools | ||
| .dockerignore | ||
| .gitignore | ||
| .gitreview | ||
| .readthedocs.yaml | ||
| .style.yapf | ||
| .zuul.yaml | ||
| LICENSE | ||
| Makefile | ||
| README.rst | ||
| requirements.txt | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
Pegleg
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: