This is an automated email from the ASF dual-hosted git repository.
bridgetb 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 57f2033 update readme.md
57f2033 is described below
commit 57f2033ecb34669050bd63842fab8ef4fef1ace4
Author: Bridget Bevens <[email protected]>
AuthorDate: Thu Jan 9 13:45:27 2020 -0800
update readme.md
---
README.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index c5e6e14..2201f70 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,13 @@ Please make sure that specific versions of libraries are
installed since buildin
# Documentation Guidelines
-The documentation pages are placed under `_docs`. Most files, in the YAML
front matter, have three important parameters:
+The documentation pages are placed under `_docs`. You can modify existing .md
files, or you can create new .md files to add to the Apache Drill documentation
site. Create pull requests to submit your documentation updates.
+
+## Creating New MarkDown Files
+
+If you create new MarkDown (.md) files, include the required YAML front matter
and name the file using the methods described in this section.
+
+The YAML front matter has 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.
