From 4fb3d363c74d164c664746d22073b6e324326e46 Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Fri, 7 Jul 2017 10:16:03 -0400 Subject: [PATCH] Setup -> Installation + title updates Updates the docs to reflect that it's not a "setup" documention but rather an installation document. I've also updated the header of architecture.md to reflect the filename. --- README.md | 12 ++++++------ docs/architecture.md | 2 +- docs/{setup.md => installation.md} | 0 3 files changed, 7 insertions(+), 7 deletions(-) rename docs/{setup.md => installation.md} (100%) diff --git a/README.md b/README.md index df1f61e6..eb636ae7 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,14 @@ Other examples are provided in the _examples_ [directory](./examples). We have multiple ways to install Kompose. Our prefered method is downloading the binary from the latest GitHub release. -Our entire list of installation methods are located in our [setup.md](/docs/setup.md) document. +Our entire list of installation methods are located in our [installation.md](/docs/installation.md) document. Installation methods: - [Binary (Prefered method)](README.md) - - [Go](/docs/setup.md#go) - - [CentOS](/docs/setup.md#centos) - - [Fedora](/docs/setup.md#fedora) - - [macOS (Homebrew)](/docs/setup.md#macos) + - [Go](/docs/installation.md#go) + - [CentOS](/docs/installation.md#centos) + - [Fedora](/docs/installation.md#fedora) + - [macOS (Homebrew)](/docs/installation.md#macos) #### Binary installation @@ -106,7 +106,7 @@ Documentation can be found at our [kompose.io](http://kompose.io) website or our Here is a list of all available docs: - [Quick start](docs/quickstart.md) -- [Setup](docs/setup.md) +- [Installation](docs/installation.md) - [User guide](docs/user-guide.md) - [Conversion](docs/conversion.md) - [Architecture](docs/architecture.md) diff --git a/docs/architecture.md b/docs/architecture.md index 77d6d8ec..3ac212dc 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,4 +1,4 @@ -# Internal Design +# Architecture and Internal Design `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. diff --git a/docs/setup.md b/docs/installation.md similarity index 100% rename from docs/setup.md rename to docs/installation.md