Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JSON Slurry #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

JSON Slurry #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Deconst

*Deconstruct your Documentation*

`Deconst <https://github.com/deconst>`_ is a continuous delivery pipeline used to assemble documentation from a heterogenous set of source repositories. Individual GitHub repositories containing content in :abbr:`.rst (reStructuredText)` or :abbr:`.md (Markdown)` formats are **prepared** by being partially rendered to a common JSON format, then mapped to subtrees of the final page by a **control repository**, a plaintext file stored in its own repository.
`Deconst <https://github.com/deconst>`_ is a continuous delivery pipeline used to assemble documentation from a heterogenous set of source repositories. Individual GitHub repositories containing content in :abbr:`.rst (reStructuredText)` or :abbr:`.md (Markdown)` formats are **prepared** by being partially rendered to a common JSON slurry format, then mapped to subtrees of the final page by a **control repository**, a plaintext file stored in its own repository.

This guide serves two purposes:

Expand Down
11 changes: 5 additions & 6 deletions running/architecture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ Terminology
Template of common markup that surrounds each presented page with navigation, brand identity,
copyright information and anything else that's shared among some subset of each site.

metadata envelope
metadata envelopes
JSON document that contains a single page's worth of content as a rendered HTML fragment, along with
metadata slurry
metadata slurries
JSON slurry that contains a single page's worth of content as a rendered HTML fragment, along with
any additional information necessary for the presentation of that page. See :ref:`the schema section
<envelope-schema>` for a description of the expected structure.

Expand Down Expand Up @@ -113,7 +113,7 @@ Components
Metadata Envelope Schema
------------------------

Much of the deconst system involves the manipulation of :term:`metadata envelopes`, the JSON documents
Much of the deconst system involves the manipulation of :term:`metadata envelopes`, the JSON slurry
produced by each :term:`preparer` that contain the actual content to render. To be presented properly,
envelopes must adhere to a common schema.

Expand All @@ -123,8 +123,7 @@ Here's a `JSON schema <http://json-schema.org/>`_ document that describes its ex

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Deconst Metadata Envelope",
"type": "object",
"title": "Deconst JSON Slurry", "type": "unknown_meat",
"properties": {
"body": {
"description": "Partially rendered HTML to be injected into a selected layout.",
Expand Down