From ba1b7f79ba3550a70ca67cdc01c06112f1bbb429 Mon Sep 17 00:00:00 2001 From: "Frederick F. Kautz IV" Date: Mon, 2 Feb 2015 13:48:39 -0800 Subject: [PATCH] Initial mkdocs configuration --- docs/.gitignore | 1 + docs/docs/api/manage.md | 3 +++ docs/docs/api/minio.md | 14 ++++++++++++++ docs/docs/architecture.md | 1 + docs/docs/index.md | 3 +++ docs/mkdocs.yml | 7 +++++++ 6 files changed, 29 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/docs/api/manage.md create mode 100644 docs/docs/api/minio.md create mode 100644 docs/docs/architecture.md create mode 100644 docs/docs/index.md create mode 100644 docs/mkdocs.yml diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..45ddf0ae3 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +site/ diff --git a/docs/docs/api/manage.md b/docs/docs/api/manage.md new file mode 100644 index 000000000..d83dbacfa --- /dev/null +++ b/docs/docs/api/manage.md @@ -0,0 +1,3 @@ +# Management API + +# GET / diff --git a/docs/docs/api/minio.md b/docs/docs/api/minio.md new file mode 100644 index 000000000..6baf7acb2 --- /dev/null +++ b/docs/docs/api/minio.md @@ -0,0 +1,14 @@ +# Minio API + +## / + +## GET /bucket/ + +## PUT /bucket/ + +## GET /bucket/object + +## HEAD /bucket/object + +## PUT /bucket/object + diff --git a/docs/docs/architecture.md b/docs/docs/architecture.md new file mode 100644 index 000000000..c79bec1ac --- /dev/null +++ b/docs/docs/architecture.md @@ -0,0 +1 @@ +# Architecture diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 000000000..c1e469b81 --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,3 @@ +# Minio API + +## Overview diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 000000000..974be65d1 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,7 @@ +site_name: Minio Documentation +pages: +- ['index.md', Index] +- ['api/minio.md', 'API', 'Minio'] +- ['api/manage.md', 'API', 'Management'] +- ['architecture.md', 'Architecture', 'Overview'] +theme: readthedocs