You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@drill.apache.org by dz...@apache.org on 2021/08/27 10:33:39 UTC
[drill-site] branch staging updated (74b9410 -> e86aeda)
This is an automated email from the ASF dual-hosted git repository.
dzamo pushed a change to branch staging
in repository https://gitbox.apache.org/repos/asf/drill-site.git.
discard 74b9410 Update README and add a Jekyll plugin to kick off createdatadocs.py.
discard d77e304 Update .asf.yaml.
add 6c6b82c Reduce .asf.yaml to config for this branch only.
add 73e6001 Set jekyll.outputdir in .asf.yaml to /.
new 04ff2d7 Set Jekyll ~> 3.9 constraint in Gemfile.
new 9228379 Update README and add a Jekyll plugin to kick off createdatadocs.py.
new e86aeda Reset .asf.yaml.
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (74b9410)
\
N -- N -- N refs/heads/staging (e86aeda)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.asf.yaml | 6 +++---
Gemfile | 5 +++--
Gemfile.lock | 35 +++++++++++++++++------------------
_config.yml | 7 +++++++
4 files changed, 30 insertions(+), 23 deletions(-)
[drill-site] 03/03: Reset .asf.yaml.
Posted by dz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
dzamo pushed a commit to branch staging
in repository https://gitbox.apache.org/repos/asf/drill-site.git
commit e86aeda24c950c8d9a85230aad5ccdd9000d3380
Author: James Turton <ja...@somecomputer.xyz>
AuthorDate: Fri Aug 27 12:33:25 2021 +0200
Reset .asf.yaml.
---
.asf.yaml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index d38d099..d0a426e 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -3,6 +3,6 @@ publish:
whoami: asf-site
jekyll:
- whoami: master
- target: asf-site
+ whoami: staging
+ target: asf-staging
outputdir: /
[drill-site] 01/03: Set Jekyll ~> 3.9 constraint in Gemfile.
Posted by dz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
dzamo pushed a commit to branch staging
in repository https://gitbox.apache.org/repos/asf/drill-site.git
commit 04ff2d7fcf87bc7bd019cf591ec2c76d75fff74e
Author: James Turton <ja...@somecomputer.xyz>
AuthorDate: Fri Aug 27 12:31:07 2021 +0200
Set Jekyll ~> 3.9 constraint in Gemfile.
---
.gitignore | 1 +
Gemfile | 5 +++--
Gemfile.lock | 35 +++++++++++++++++------------------
_config.yml | 7 +++++++
4 files changed, 28 insertions(+), 20 deletions(-)
diff --git a/.gitignore b/.gitignore
index d762556..077a2b7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,6 @@
.bundle
vendor
+.jekyll-cache
.jekyll-metadata
_site/*
.sass-cache/*
diff --git a/Gemfile b/Gemfile
index dc46896..881987a 100644
--- a/Gemfile
+++ b/Gemfile
@@ -6,6 +6,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
# gem "rails"
-gem "jekyll", "~> 4.2"
-
+gem "jekyll", "~> 3.9"
gem "jekyll-polyglot", "~> 1.5"
+
+gem "kramdown-parser-gfm", "~> 1.1"
diff --git a/Gemfile.lock b/Gemfile.lock
index 3977062..5728531 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -12,27 +12,25 @@ GEM
ffi (1.15.3)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
- i18n (1.8.10)
+ i18n (0.9.5)
concurrent-ruby (~> 1.0)
- jekyll (4.2.0)
+ jekyll (3.9.1)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
- i18n (~> 1.0)
- jekyll-sass-converter (~> 2.0)
+ i18n (~> 0.7)
+ jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
- kramdown (~> 2.3)
- kramdown-parser-gfm (~> 1.0)
+ kramdown (>= 1.17, < 3)
liquid (~> 4.0)
- mercenary (~> 0.4.0)
+ mercenary (~> 0.3.3)
pathutil (~> 0.9)
- rouge (~> 3.0)
+ rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
- terminal-table (~> 2.0)
jekyll-polyglot (1.5.0)
jekyll (>= 3.0)
- jekyll-sass-converter (2.1.0)
- sassc (> 2.0.1, < 3.0)
+ jekyll-sass-converter (1.5.2)
+ sass (~> 3.4)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.3.1)
@@ -43,7 +41,7 @@ GEM
listen (3.7.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
- mercenary (0.4.0)
+ mercenary (0.3.6)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.6)
@@ -53,18 +51,19 @@ GEM
rexml (3.2.5)
rouge (3.26.0)
safe_yaml (1.0.5)
- sassc (2.4.0)
- ffi (~> 1.9)
- terminal-table (2.0.0)
- unicode-display_width (~> 1.1, >= 1.1.1)
- unicode-display_width (1.7.0)
+ sass (3.7.4)
+ sass-listen (~> 4.0.0)
+ sass-listen (4.0.0)
+ rb-fsevent (~> 0.9, >= 0.9.4)
+ rb-inotify (~> 0.9, >= 0.9.7)
PLATFORMS
x86_64-linux
DEPENDENCIES
- jekyll (~> 4.2)
+ jekyll (~> 3.9)
jekyll-polyglot (~> 1.5)
+ kramdown-parser-gfm (~> 1.1)
BUNDLED WITH
2.2.5
diff --git a/_config.yml b/_config.yml
index 52bf95d..db75757 100644
--- a/_config.yml
+++ b/_config.yml
@@ -37,6 +37,13 @@ include:
- .asf.yaml
exclude:
+ - Gemfile
+ - Gemfile.lock
+ - node_modules
+ - vendor/bundle/
+ - vendor/cache/
+ - vendor/gems/
+ - vendor/ruby/
- .gitignore
languages: ["en", "zh"]
[drill-site] 02/03: Update README and add a Jekyll plugin to kick
off createdatadocs.py.
Posted by dz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
dzamo pushed a commit to branch staging
in repository https://gitbox.apache.org/repos/asf/drill-site.git
commit 9228379a515ceb4a21ef37d81dceefb73c08b0cf
Author: James Turton <ja...@somecomputer.xyz>
AuthorDate: Fri Aug 27 11:34:24 2021 +0200
Update README and add a Jekyll plugin to kick off createdatadocs.py.
---
README.md | 89 +++++++++++++-------------------------------
_plugins/create_data_docs.rb | 4 ++
2 files changed, 30 insertions(+), 63 deletions(-)
diff --git a/README.md b/README.md
index 8da4aa3..a8bbb9b 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,30 @@
-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.
+**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 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.
+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.
-# Configuring env
+| Source Markdown branch | Generated HTML branch | Publish URL |
+| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------- |
+| [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 |
-1. Install `ruby`
-2. Install `bundler` and `jekyll` `v3.9.0`:
+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.
-```
-gem install bundler jekyll:3.9.0
-```
+# Continuous Integration
-3. Install Jekyll plugins.
+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 [...]
-```
-gem install jekyll-redirect-from:0.9.1
-gem install jekyll-polyglot
-```
+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.
-5. Install Python 3
+# Building locally
-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.
+For more extensive documentation contributions it is beneficial to build and serve the website locally.
-## Note for existing contributors
+# Configuring env
-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
-trouble generating the site.
+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
@@ -64,13 +58,11 @@ Best practices:
To preview the website on your local machine:
```bash
-jekyll build --config _config.yml,_config-prod.yml
-_tools/createdatadocs.py
-jekyll serve --config _config.yml,_config-prod.yml [--livereload] [--incremental]
+bundle exec jekyll build
+bundle exec jekyll serve [--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.
+Once you're happy with the results, commit to the source Markdown branch and push to your fork, or directly to drill-site if you're a Drill committer.
## One Time Setup for Last-Modified-Date
@@ -109,50 +101,21 @@ Do not fill in or alter the date: field. Jekyll and git take care of that when y
# 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.
+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
-1. Add the two-letter language code (`lang-code` forthwith) to the `languages` property in _config.yml.
+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.
3. Add a `lang-code/` subdirectory to each collection that will be translated, e.g. `_docs/lang-code/`.
-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.
+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
-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.
+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
-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 cont [...]
-
-# 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>).
-
-```bash
-jekyll build --config _config.yml,_config-prod.yml
-_tools/createdatadocs.py
-jekyll serve --config _config.yml,_config-prod.yml
-```
-
-# Uploading to the Apache Website (Drill Committers Only)
-
-Apache project websites use a system called svnpubsub for publishing. Basically, the static HTML needs to be pushed by one of the committers into the Apache SVN.
-
-```bash
-git clone -b asf-site https://gitbox.apache.org/repos/asf/drill-site.git ../drill-site
-rm -rf ../drill-site/*
-cp -R _site/* ../drill-site/
-cd ../drill-site
-git status
-git add *
-git commit -m "Website update"
-git push
-```
+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 [...]
-The updates should then be live: <http://drill.apache.org>.
diff --git a/_plugins/create_data_docs.rb b/_plugins/create_data_docs.rb
new file mode 100644
index 0000000..452e433
--- /dev/null
+++ b/_plugins/create_data_docs.rb
@@ -0,0 +1,4 @@
+Jekyll::Hooks.register :site, :post_write do |site|
+ puts 'Jekyll post_write hook in create_data_docs.rb: running _tools/createdatadocs.py'
+ system 'python3 _tools/createdatadocs.py'
+end