[drill-site] branch master updated: Update README.md

[dz...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dzamo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/drill-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 69ebadf  Update README.md
69ebadf is described below

commit 69ebadf665d65c13aa334c3e7c830bcd4b80ab62
Author: James Turton <91...@users.noreply.github.com>
AuthorDate: Mon Jan 3 10:49:34 2022 +0200

    Update README.md
---
 README.md | 28 +++++++++++++++-------------
 1 file changed, 15 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 7caac9c..7b1da29 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,8 @@
-**N.B.** As of 2021-08-27, documentation is no longer kept in drill/gh-pages.  All documentation, including both the source Markdown and the generated HTML is now kept in this repository.  To contribute documentation please send a pull request containing your edits to the master branch of this repository.
+## Using the GitHub web editor for minor updates
+
+The fastest way to contribute documentation to an existing page is to browse in the GitHub web UI to the relevant markdown file in the master branch of this repository and click the edit button.  When you save your work by committing it, GitHub will automatically create a fork and a PR for you or commit your change directly if you're a project committer.  To make documentation contributions easier, pull requests to this repository do not require the creation of JIRA ticket.  Nevertheless [...]
+
+## Overview
 
 The Apache Drill website is built by [Jekyll](http://jekyllrb.com/) from Markdown sources in designated branches of this repository.  The build process flows from left to right in the following table.
 
@@ -7,30 +11,28 @@ The Apache Drill website is built by [Jekyll](http://jekyllrb.com/) from Markdow
 | [drill-site/master](https://github.com/apache/drill-site/tree/master)   | [drill-site/asf-site](https://github.com/apache/drill-site/tree/asf-site)       | https://drill.apache.org        |
 | [drill-site/staging](https://github.com/apache/drill-site/tree/staging) | [drill-site/asf-staging](https://github.com/apache/drill-site/tree/asf-staging) | https://drill.staged.apache.org |
 
-To make documenation contributions easier, pull requests to this repository do not require the creation of JIRA ticket.  Nevertheless, a Drill project commiter will still need to check and merge a submitted PR.
-
-# Continuous Integration
+## Continuous Integration
 
 When new commits are pushed to any of the listed source Markdown branches, a Jekyll website build will be kicked off.  You can monitor the build, which normally runs in about 3 minutes, and view its logs at https://ci2.apache.org/.  Once the build completes, the resulting website will automatically be committed to the corresponding HTML branch in the table above.  The commit to the HTML branch will result in a deployment to the corresponding publish URL.  While it is possible to push com [...]
 
 At the time of writing, the staging website has no designated reponsibility and you may freely use it to test things out without worrying about what you clobber there.  Note that this means that others can freely clobber your staging deployments too.
 
-# Building locally
+## Building locally
 
 For more extensive documentation contributions it is beneficial to build and serve the website locally.
 
-# Configuring env
+## Configuring env
 
 1. Install the Ruby language and Bundler.
 2. Clone this repository and checkout a source Markdown branch.
 3. In the project root directory, install gems with `bundle install`.
 4. Install Python 3.
 
-# Documentation Guidelines
+## Documentation Guidelines
 
 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. The Kramdown Markdown processor employed by Jekyll supports [a dialect of Markdown](https://kramdown.gettalong.org/quickref.html) which is a superset of standard Markdown.
 
-## Creating New Markdown Files
+### 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.
 
@@ -53,7 +55,7 @@ Best practices:
   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
+## Developing and Previewing the Website
 
 To preview the website on your local machine:
 
@@ -99,11 +101,11 @@ date:
 
 Do not fill in or alter the date: field. Jekyll and git take care of that when you commit the file.
 
-# Multilingual
+## Multilingual
 
 Multilingual support was added to the website in June 2021 using the polyglot Jekyll plugin. The fallback language is set to English which means that when a translated page is not available the English version will be shown. This means that a language which is incompletely translated is still deployable with no adverse effects.
 
-## Add a new language
+### Add a new language
 
 1. Add the two-letter language code (`lang-code` forthwith) to the `languages` property in \_config.yml.
 2. Add a `lang-code/` subdirectory to the root directory.
@@ -111,11 +113,11 @@ Multilingual support was added to the website in June 2021 using the polyglot Je
 4. Check the `exclude_from_localization` list in \_config.yml to ensure that the content you
    want to translate is not excluded from processing by the multlingual plugin.
 
-## Add translated site pages
+### Add translated site pages
 
 The English versions of "site" pages such as index.html are stored in the root directory. Create corresponding translated pages under `lang-code/` in which you set `lang` in the front matter to `lang-code` and leave the `permalink` the same as the English page.
 
-## Add translated collection pages
+### Add translated collection pages
 
 The English versions of "collection" pages such as the markdown under \_docs/ are stored in an en/ subdirectory of the collection root. Create corresponding translated pages in the collection under `lang-code/` in which you translate both `title` and `parent` in the front matter but leave the `slug` the same as the English page and set `lang` to `lang-code`. Once you've translated the `title` of a parent page, you will need to provide files for each of its children (which can still conta [...]