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.

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

Update and revamp documentation #4

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Changes from 2 commits
Commits
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
118 changes: 118 additions & 0 deletions new-manual.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
Proposed outline of new documentation. Each heading is a page, with bullet
points explaining content.

Pages:

<!-- MarkdownTOC -->

* [Introduction](#introduction)
* [Installation](#installation)
* [Tutorial](#tutorial)
* [Getting Started](#getting-started)
* [Libraries](#libraries)
* [Directory Structure](#directory-structure)
* [Next Steps](#next-steps)
* [Configuration and CLI](#configuration-and-cli)
* [build](#build)
* [update](#update)
* [visualize](#visualize)
* [Inheritance and Merging](#inheritance-and-merging)
* [Metadata](#metadata)
* [Manifests](#manifests)
* [Processors](#processors)
* [Kubernetes (:kube)](#kubernetes-kube)
* [Advanced techniques](#advanced-techniques)
* [In-line Clojure](#in-line-clojure)
* [Rolling out changes](#rolling-out-changes)

<!-- /MarkdownTOC -->

# Introduction

* Intro
* Rationale

# Installation

* Comprehensive installation instructions

# Tutorial

## Getting Started

* Installation
* Intro to EDN
* First run
* 0 to first Kubernetes manifest generated

## Libraries

* Parent libraries
* Deep merging overview and examples
* Extracting out parent libraries
* Intro to metadata

## Directory Structure

* Typical directory structure
* Intro to inheritance

## Next Steps

* Links to remaining documentation

# Configuration and CLI

* Summary
* Configuration

## build

* Examples

## update

* Examples

## visualize

* Examples

# Inheritance and Merging

* Tree project structure
* Merging logic
* Deep merge examples

# Metadata

* Metadata definition and use
* Metadata in files

# Manifests

* Rationale
* Examples

# Processors

* General information

## Kubernetes (:kube)

* Special metadata (tags)
* Special vectors of maps
* Environment handling

# Advanced techniques

## In-line Clojure

* Intro to Clojure
* Examples
* Catalog of included libraries

## Rolling out changes

* Environment-specific override
* Code conditional