This is an automated email from the ASF dual-hosted git repository. dzamo pushed a commit to branch gh-pages in repository https://gitbox.apache.org/repos/asf/drill.git
commit 1b74ef6b3e5f786879f8e9b0a9134b1c29b0de9b Author: James Turton <[email protected]> AuthorDate: Mon May 10 06:02:19 2021 +0200 Add note about where and how to contribute docs to README. --- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 46 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 3f2df7d..f46f670 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,34 @@ -The Apache Drill website is built using [Jekyll](http://jekyllrb.com/). +The Apache Drill website is built using [Jekyll](http://jekyllrb.com/), from Markdown sources in the +[drill/gh-pages](https://github.com/apache/drill/tree/gh-pages branch of the main Drill code repository. +Changes made anywhere downstream of that will be lost in the next build and deploy cycle. + +To make documenation contributions easier, pull requests to the gh-pages branch do not require any +additional process, such as the creation of a JIRA ticket. # Configuring env + 1. Install `ruby` 2. Install `bundler` and `jekyll` `v3.9.0`: + ``` gem install bundler jekyll:3.9.0 ``` + 3. Install `jekyll-redirect-from` `v0.9.1`: + ``` gem install jekyll-redirect-from:0.9.1 ``` + 4. Install Python 3 -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. +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. ## Note for existing contributors + The software version numbers above underwent a major increase in 2020 and the Markdown processor -changed from Redcarpet to Kramdown. Please check the versions in your environment if you're having +changed from Redcarpet to Kramdown. Please check the versions in your environment if you're having trouble generating the site. # Documentation Guidelines @@ -25,21 +37,26 @@ The documentation pages are placed under `_docs`. You can modify existing .md fi ## 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. +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 -* `slug:` - Set this to the same value as `title`, it will be slugified automatically by Jekyll. -* `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. +- `title:` - This is the title of the page enclosed in quotation marks. Each page must have a _unique_ title +- `slug:` - Set this to the same value as `title`, it will be slugified automatically by Jekyll. +- `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. +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 slugified 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). +- 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 slugified 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 @@ -50,13 +67,16 @@ jekyll build --config _config.yml,_config-prod.yml _tools/createdatadocs.py jekyll serve --config _config.yml,_config-prod.yml [--livereload] [--incremental] ``` -Note that you can skip the first two commands (and only run `jekyll serve`) if you haven't changed the title or path of any of the documentation pages. + +Note that you can skip the first two commands (and only run `jekyll serve`) if you haven't changed the title or +path of any of the documentation pages. ## One Time Setup for Last-Modified-Date To automatically add the `last-modified-on date`, a one-time local setup is required: 1. In your cloned directory of Drill, in `drill/.git/hooks`, create a file named `pre-commit` (no extension) that contains this script: + ``` #!/bin/sh # Contents of .git/hooks/pre-commit @@ -67,42 +87,51 @@ git diff --cached --name-status | grep "^M" | while read a b; do git add $b done ``` + 2. Make the file executable. + ``` chmod +x pre-commit ``` + 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" parent: "Configuring a Multitenant Cluster" -date: +date: --- ``` -Do not fill in or alter the date: field. Jekyll and git take care of that when you commit the file. + +Do not fill in or alter the date: field. Jekyll and git take care of that when you commit the file. ## One Time Setup for Redirecting gh-pages Locally install the `jekyll-redirect-from` gem: + ``` gem install jekyll-redirect-from ``` + On any page you want to redirect, add the redirect_to: and the URL to the front matter. For example: + ``` --- title: "Configuring Multitenant Resources" parent: "Configuring a Multitenant Cluster" -date: +date: redirect_to: - http://<new_url> --- ``` + # Compiling the Website Once the website is ready, you'll need to compile the site to static HTML so that it can then be published to Apache. This is as simple as running the `jekyll build` command. The `_config-prod.yml` configuration file causes a few changes to the site: -* The `noindex` meta tag is removed. We want the production site to be indexed by search engines, but we don't want the staging site to be indexed. -* The base URL is set to `/`. The production site is at `/`, whereas the staging site is at `/drill` (convenient for previewing on GitHub Pages: <http://apache.github.io/drill>). +- The `noindex` meta tag is removed. We want the production site to be indexed by search engines, but we don't want the staging site to be indexed. +- The base URL is set to `/`. The production site is at `/`, whereas the staging site is at `/drill` (convenient for previewing on GitHub Pages: <http://apache.github.io/drill>). ```bash jekyll build --config _config.yml,_config-prod.yml
