You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@drill.apache.org by ts...@apache.org on 2015/01/07 19:19:06 UTC
[2/2] drill git commit: Completed basic documentation layout
Completed basic documentation layout
Project: http://git-wip-us.apache.org/repos/asf/drill/repo
Commit: http://git-wip-us.apache.org/repos/asf/drill/commit/b5c6557e
Tree: http://git-wip-us.apache.org/repos/asf/drill/tree/b5c6557e
Diff: http://git-wip-us.apache.org/repos/asf/drill/diff/b5c6557e
Branch: refs/heads/gh-pages
Commit: b5c6557e44e01507867dc9694fbd7708e0ef802f
Parents: 8ac0d95
Author: Tomer Shiran <ts...@gmail.com>
Authored: Wed Jan 7 10:17:34 2015 -0800
Committer: Tomer Shiran <ts...@gmail.com>
Committed: Wed Jan 7 10:17:34 2015 -0800
----------------------------------------------------------------------
_config.yml | 5 ++++
_data/docs.json | 22 --------------
_docs/001-user-guide.md | 5 ++++
_docs/002-admin-guide.md | 6 ++++
_docs/user-guide/001-views.md | 6 ++++
_docs/user-guide/002-sql-syntax.md | 6 ++++
_docs/user-guide/sql-syntax/001-ddd-ddd.md | 8 +++++
_docs/user-guide/views/001-aaa-aaa.md | 8 +++++
_docs/user-guide/views/002-bbb-bbb.md | 8 +++++
_docs/user-guide/views/003-ccc-ccc.md | 8 +++++
docs.html | 39 +++++++++++++++++++++++++
docs/aaa-aaa.md | 7 -----
docs/bbb-bbb.md | 7 -----
docs/ccc-ccc.md | 7 -----
docs/ddd-ddd.md | 0
docs/eee-eee.md | 0
docs/index.html | 21 -------------
17 files changed, 99 insertions(+), 64 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
index 9da420a..aba0a2a 100644
--- a/_config.yml
+++ b/_config.yml
@@ -12,3 +12,8 @@ description: > # this means to ignore newlines until "baseurl:"
baseurl: "/drill" # Base URL when hosted on GitHub Pages (drill repository under apache account)
noindex: 1
markdown: redcarpet
+
+collections:
+ docs:
+ output: true
+ permalink: /docs/:title/
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_data/docs.json
----------------------------------------------------------------------
diff --git a/_data/docs.json b/_data/docs.json
deleted file mode 100644
index cb8f1c4..0000000
--- a/_data/docs.json
+++ /dev/null
@@ -1,22 +0,0 @@
-[
- {
- "title": "User Guide",
- "children": [
- {
- "title": "Views",
- "children": [
- { "title": "Aaa Aaa", "name": "aaa-aaa" },
- { "title": "Bbb Bbb", "name": "bbb-bbb" }
- ]
- },
- {
- "title": "SQL Syntax",
- "children": [
- { "title": "Ccc Ccc", "name": "ccc-ccc" },
- { "title": "Ddd Ddd", "name": "ddd-ddd" },
- { "title": "Eee Eee", "name": "eee-eee" }
- ]
- }
- ]
- }
-]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_docs/001-user-guide.md
----------------------------------------------------------------------
diff --git a/_docs/001-user-guide.md b/_docs/001-user-guide.md
new file mode 100644
index 0000000..826d304
--- /dev/null
+++ b/_docs/001-user-guide.md
@@ -0,0 +1,5 @@
+---
+layout: docpage
+title: "User Guide"
+---
+This is a user guide!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_docs/002-admin-guide.md
----------------------------------------------------------------------
diff --git a/_docs/002-admin-guide.md b/_docs/002-admin-guide.md
new file mode 100644
index 0000000..69c2129
--- /dev/null
+++ b/_docs/002-admin-guide.md
@@ -0,0 +1,6 @@
+---
+layout: docpage
+title: "Admin Guide"
+nocontent: true
+---
+This is an Admin Guide...
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_docs/user-guide/001-views.md
----------------------------------------------------------------------
diff --git a/_docs/user-guide/001-views.md b/_docs/user-guide/001-views.md
new file mode 100644
index 0000000..ca52a4a
--- /dev/null
+++ b/_docs/user-guide/001-views.md
@@ -0,0 +1,6 @@
+---
+layout: docpage
+title: "Views"
+parent: "User Guide"
+---
+Views!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_docs/user-guide/002-sql-syntax.md
----------------------------------------------------------------------
diff --git a/_docs/user-guide/002-sql-syntax.md b/_docs/user-guide/002-sql-syntax.md
new file mode 100644
index 0000000..56e0e48
--- /dev/null
+++ b/_docs/user-guide/002-sql-syntax.md
@@ -0,0 +1,6 @@
+---
+layout: docpage
+title: "SQL Syntax"
+parent: "User Guide"
+---
+SQL Syntax!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_docs/user-guide/sql-syntax/001-ddd-ddd.md
----------------------------------------------------------------------
diff --git a/_docs/user-guide/sql-syntax/001-ddd-ddd.md b/_docs/user-guide/sql-syntax/001-ddd-ddd.md
new file mode 100644
index 0000000..c83fe3c
--- /dev/null
+++ b/_docs/user-guide/sql-syntax/001-ddd-ddd.md
@@ -0,0 +1,8 @@
+---
+layout: docpage
+title: "A page on Ds"
+parent: "SQL Syntax"
+---
+This is a documentation page.
+
+It talks about Ds.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_docs/user-guide/views/001-aaa-aaa.md
----------------------------------------------------------------------
diff --git a/_docs/user-guide/views/001-aaa-aaa.md b/_docs/user-guide/views/001-aaa-aaa.md
new file mode 100644
index 0000000..d4d7862
--- /dev/null
+++ b/_docs/user-guide/views/001-aaa-aaa.md
@@ -0,0 +1,8 @@
+---
+layout: docpage
+title: "This is Aaa Aaa"
+parent: "Views"
+---
+This is a documentation page.
+
+It talks about As.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_docs/user-guide/views/002-bbb-bbb.md
----------------------------------------------------------------------
diff --git a/_docs/user-guide/views/002-bbb-bbb.md b/_docs/user-guide/views/002-bbb-bbb.md
new file mode 100644
index 0000000..9f97ae5
--- /dev/null
+++ b/_docs/user-guide/views/002-bbb-bbb.md
@@ -0,0 +1,8 @@
+---
+layout: docpage
+title: "Bbb Bbb"
+parent: "Views"
+---
+This is a documentation page.
+
+It talks about Bs.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/_docs/user-guide/views/003-ccc-ccc.md
----------------------------------------------------------------------
diff --git a/_docs/user-guide/views/003-ccc-ccc.md b/_docs/user-guide/views/003-ccc-ccc.md
new file mode 100644
index 0000000..62060b8
--- /dev/null
+++ b/_docs/user-guide/views/003-ccc-ccc.md
@@ -0,0 +1,8 @@
+---
+layout: docpage
+title: "Another page"
+parent: "Views"
+---
+This is a documentation page.
+
+It talks about Cs.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/docs.html
----------------------------------------------------------------------
diff --git a/docs.html b/docs.html
new file mode 100644
index 0000000..1f0b037
--- /dev/null
+++ b/docs.html
@@ -0,0 +1,39 @@
+---
+layout: page
+title: Documentation
+---
+{% comment %}
+Notes:
+* Other doc attributes: relative_path, url
+* Directories don't matter at all. You don't have to use them.
+* File names don't matter either, except the alphabetical order between them.
+{% endcomment %}
+<ul>
+{% for doc0 in site.docs %}
+ {% if doc0.parent == null %}
+ {% if doc0.nocontent %}<li>{{ doc0.title }}</li>{% else %}<li><a href="{{ site.baseurl }}/docs/{{ doc0.title | slugify }}/">{{ doc0.title }}</a></li>{% endif %}
+ {% assign doc0_has_children = false %}
+ {% for doc1 in site.docs %}{% if doc1.parent == doc0.title %}{% assign doc0_has_children = true %}{% endif %}{% endfor %}
+ {% if doc0_has_children %}
+ <ul>
+ {% for doc1 in site.docs %}
+ {% if doc1.parent == doc0.title %}
+ {% if doc1.nocontent %}<li>{{ doc1.title }}</li>{% else %}<li><a href="{{ site.baseurl }}/docs/{{ doc1.title | slugify }}/">{{ doc1.title }}</a></li>{% endif %}
+ {% assign doc1_has_children = false %}
+ {% for doc2 in site.docs %}{% if doc2.parent == doc1.title %}{% assign doc1_has_children = true %}{% endif %}{% endfor %}
+ {% if doc1_has_children %}
+ <ul>
+ {% for doc2 in site.docs %}
+ {% if doc2.parent == doc1.title %}
+ <li><a href="{{ site.baseurl }}/docs/{{ doc2.title | slugify }}/">{{ doc2.title }}</a></li>
+ {% endif %}
+ {% endfor %}
+ </ul>
+ {% endif %}
+ {% endif %}
+ {% endfor %}
+ </ul>
+ {% endif %}
+ {% endif %}
+{% endfor %}
+</ul>
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/docs/aaa-aaa.md
----------------------------------------------------------------------
diff --git a/docs/aaa-aaa.md b/docs/aaa-aaa.md
deleted file mode 100644
index 8d58be3..0000000
--- a/docs/aaa-aaa.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-layout: docpage
-title: "Aaa Aaa"
----
-This is a documentation page.
-
-It talks about As.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/docs/bbb-bbb.md
----------------------------------------------------------------------
diff --git a/docs/bbb-bbb.md b/docs/bbb-bbb.md
deleted file mode 100644
index 66929da..0000000
--- a/docs/bbb-bbb.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-layout: docpage
-title: "Bbb Bbb"
----
-This is a documentation page.
-
-It talks about Bs.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/docs/ccc-ccc.md
----------------------------------------------------------------------
diff --git a/docs/ccc-ccc.md b/docs/ccc-ccc.md
deleted file mode 100644
index c30a5b4..0000000
--- a/docs/ccc-ccc.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-layout: docpage
-title: "Ccc Ccc"
----
-This is a documentation page.
-
-It talks about Cs.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/docs/ddd-ddd.md
----------------------------------------------------------------------
diff --git a/docs/ddd-ddd.md b/docs/ddd-ddd.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/docs/eee-eee.md
----------------------------------------------------------------------
diff --git a/docs/eee-eee.md b/docs/eee-eee.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/drill/blob/b5c6557e/docs/index.html
----------------------------------------------------------------------
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100644
index 8ebba1a..0000000
--- a/docs/index.html
+++ /dev/null
@@ -1,21 +0,0 @@
----
-layout: page
-title: Documentation
----
-Table of contents:
-
-<ul>
-{% for book in site.data.docs %}
- <li>{{ book.title }}</li>
- <ul>
- {% for section in book.children %}
- <li>{{ section.title }}</li>
- <ul>
- {% for chapter in section.children %}
- <li><a href="{{ site.baseurl }}/docs/{{ chapter.name }}/">{{ chapter.title }}</a></li>
- {% endfor %}
- </ul>
- {% endfor %}
- </ul>
-{% endfor %}
-</ul>
\ No newline at end of file