This is an automated email from the ASF dual-hosted git repository.
volodymyr pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/drill.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new d41b430 Update README.md
d41b430 is described below
commit d41b430a679ca2a46131136a6b3d08fe4c505855
Author: Volodymyr Vysotskyi <[email protected]>
AuthorDate: Fri Jan 3 18:05:07 2020 +0200
Update README.md
---
README.md | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 29f3566..c5e6e14 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,21 @@ gem install jekyll-redirect-from:0.9.1
Please make sure that specific versions of libraries are installed since
building the site with other versions may cause some issues like including md
document index into the references, etc.
+# Documentation Guidelines
+
+The documentation pages are placed under `_docs`. Most files, in the YAML
front matter, have three important parameters:
+
+* `title:` - This is the title of the page enclosed in quotation marks. Each
page must have a *unique* title
+* `date:` - This field is needed for Jekyll to write a last-modified date.
Initially, leave this field blank.
+* `parent:` - This is the title of the page's parent page. It should be empty
for top-level sections/guides, and be identical to the title attribute of
another page in all other cases.
+
+The name of the file itself doesn't matter except for the alphanumeric order
of the filenames. Files that share the same parent are ordered
alphanumerically. Note that the content of parent files is ignored, so add an
overview/introduction child when needed.
+
+Best practices:
+
+* Prefix the filenames with `010-foo.md`, `020-bar.md`, `030-baz.md`, etc.
This allows room to add files in-between (eg, `005-qux.md`).
+* Use the slug of the title as the filename. For example, if the title is
"Getting Started with Drill", name the file
`...-getting-started-with-drill.md`. If you're not sure what the slug is, you
should be able to see it in the URL and then adjust (the URLs are
auto-generated based on the title attribute).
+
# Developing and Previewing the Website
To preview the website on your local machine:
@@ -44,7 +59,7 @@ done
```
chmod +x pre-commit
```
-On any page you create, in addition to the title, and `parent:`, you now need
to add `date:` to the front matter of any file you create. For example:
+On the page you create, in addition to the title, and `parent:`, you now need
to add `date:` to the front matter of any file you create. For example:
```
---
title: "Configuring Multitenant Resources"
@@ -99,18 +114,3 @@ git push
```
The updates should then be live: <http://drill.apache.org>.
-
-# Documentation Guidelines
-
-The documentation pages are under `_docs`. Most files, in the YAML front
matter, have three important parameters:
-
-* `title:` - This is the title of the page enclosed in quotation marks. Each
page must have a *unique* title
-* `date:` - This field is needed for Jekyll to write a last-modified date.
Initially, leave this field blank.
-* `parent:` - This is the title of the page's parent page. It should be empty
for top-level sections/guides, and be identical to the title attribute of
another page in all other cases.
-
-The name of the file itself doesn't matter except for the alphanumeric order
of the filenames. Files that share the same parent are ordered
alphanumerically. Note that the content of parent files is ignored, so add an
overview/introduction child when needed.
-
-Best practices:
-
-* Prefix the filenames with `010-foo.md`, `020-bar.md`, `030-baz.md`, etc.
This allows room to add files in-between (eg, `005-qux.md`).
-* Use the slug of the title as the filename. For example, if the title is
"Getting Started with Drill", name the file
`...-getting-started-with-drill.md`. If you're not sure what the slug is, you
should be able to see it in the URL and then adjust (the URLs are
auto-generated based on the title attribute).
