Add TOC to documentation, add readme.md notice

Adds TOC to architecture.md, getting-started.md, integrations.md and
user-guide.md

Updates README.md to add a notice that the files are best viewed on the
website.
This commit is contained in:
Charlie Drage
2017-11-06 10:55:04 -05:00
parent c7964e71e7
commit e5b1f02b5e
5 changed files with 11 additions and 23 deletions
+3
View File
@@ -1,5 +1,8 @@
# Architecture and Internal Design
* TOC
{:toc}
`kompose` has 3 stages: Loader, Transformer and Outputter. Each Stage should have well defined interface so it is easy to write new Loader, Transformer or Outputters and plug it in. Currently only Loader and Transformer interfaces are defined.
![Design Diagram](/docs/images/design_diagram.png)