http://git-wip-us.apache.org/repos/asf/geode/blob/da3767da/geode-site/website/.gitignore ---------------------------------------------------------------------- diff --git a/geode-site/website/.gitignore b/geode-site/website/.gitignore deleted file mode 100644 index 3fec32c..0000000 --- a/geode-site/website/.gitignore +++ /dev/null @@ -1 +0,0 @@ -tmp/
http://git-wip-us.apache.org/repos/asf/geode/blob/da3767da/geode-site/website/README.md ---------------------------------------------------------------------- diff --git a/geode-site/website/README.md b/geode-site/website/README.md deleted file mode 100644 index 1f93e24..0000000 --- a/geode-site/website/README.md +++ /dev/null @@ -1,100 +0,0 @@ -# Apache Geode Website - -This directory contains the source files for the project website. Website content is written in [Markdown](https://help.github.com/articles/markdown-basics) and the site files are generated from that source by a tool called [Pandoc](http://johnmacfarlane.net/pandoc). - -Source files for the website are in `${geode-project-dir}/geode-site/website/content`. - -Generated files for the website are in `${geode-project-dir}/geode-site/content`. - -**NOTE:** To make changes to the [Apache Geode User Guide](http://geode.apache.org/docs/), which is published to the website: - -- See `${geode-project-dir}/geode-docs/CONTRIBUTE.md` for information about contributing to the documentation source files. -- See `${geode-project-dir}/geode-book/README.md` for information about building a local version of the guide and adding it to the website. - -The website is updated by a "sync" tool that monitors the __asf-site__ branch -of our Git repo, so after making changes you must place your updated source -and generated files on the __asf-site__ branch and push. -The content will be published to the -[Geode website](http://geode.apache.org) after a 5-20 minute delay. - -## Prerequisites - -To generate the site locally, you need Ruby, Python, Pandoc and a couple of Ruby Gems. - -Install Pandoc (Haskell-based markup format converter): - - http://johnmacfarlane.net/pandoc/installing.html - -Install Pygments (Python-based syntax coloring library): - - $ sudo easy_install Pygments - -Install Nanoc and other Ruby Gems needed: - - $ sudo gem install nanoc -v 4.2.0 - $ sudo gem install pygments.rb htmlentities pandoc-ruby nokogiri rack mime-types adsf - -## How to change/update the website - -### 1. Find and edit the source files you need to change - -Source files for the website are in -``${geode-project-dir}/geode-site/website/content``. -When changing the actual content of the site, find the Markdown files that you -need to edit under the `${geode-project-dir}/geode-site/website/content/` -directory and make your change. - -If you need to change the layout or styling of the site, -then you will probably need to change an HTML, JS or CSS file -within the ``${geode-project-dir}/geode-site/website/content`` directory. - -**NOTE:** The [Apache Geode User Guide](http://geode.apache.org/docs/guide/About_Geode.html) source files are in `${geode-project-dir}/geode-docs/`. See `${geode-project-dir}/geode-docs/CONTRIBUTE.md` for more information. - -### 2. Locally generate the site and test your changes - -Run the nanoc compiler to generate the site. -Nanoc is configured by the -``${geode-project-dir}/geode-site/website/nanoc.yaml`` -file to place the locally built website into the -``${geode-project-dir}/geode-site/content`` directory. -With a cwd of ``${geode-project-dir}/geode-site/website``: - - $ nanoc compile -Run ``git status`` and you should see your changes plus any updated files -under the ``${geode-project-dir}/content`` directory. - -To view your changes locally, use the view command to start a local web server. Check the website at [http://0.0.0.0:3000](http://0.0.0.0:3000) - - $ nanoc view - -To make further changes, stop the web server, edit files, recompile, and view again. - -### 3. Publish your changes to the site - -Once you are happy with your changes, commit them to the __develop__ branch. -The changes also need to be propagated to the __asf-site__ branch. -However, the file structure of the __asf-site__ branch is unusual, so a -git merge will not do the right thing. - -The compiled ``${geode-project-dir}/geode-site/content`` directory -from the __develop__ branch will need to be placed at the -top level, ``${geode-project-dir}``, of the __asf-site__ branch. -Here is one way to accomplish this: - -1. On the __develop__ branch - - $ cd geode-site/website - $ nanoc compile - $ cd ../content - $ tar cvf new-website-content.tar . - $ mv new-website-content.tar ~/Desktop/ - -2. Expand the TAR file at the top level of the __asf-site__ branch. Set your working directory to ${geode-project-dir}, checkout the __asf-site__ branch, and run a `git clean -xdf` command before unpacking your tar file: - - $ git checkout asf-site - $ git clean -xdf - $ tar xvf ~/Desktop/new-website-content.tar - -3. Commit and push on the __asf-site__ branch - -The site should update in 5-10 minutes. If it does not, [file a JIRA against the INFRA project](https://issues.apache.org/jira/browse/INFRA) or ask for advice on the Infrastructure project's HipChat room [#asfinfra](https://www.hipchat.com/g4P84gemn). http://git-wip-us.apache.org/repos/asf/geode/blob/da3767da/geode-site/website/Rules ---------------------------------------------------------------------- diff --git a/geode-site/website/Rules b/geode-site/website/Rules deleted file mode 100644 index 5603684..0000000 --- a/geode-site/website/Rules +++ /dev/null @@ -1,70 +0,0 @@ - -#!/usr/bin/env ruby -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -# A few helpful tips about the Rules file: -# -# * The string given to #compile and #route are matching patterns for -# identifiers--not for paths. Therefore, you canât match on extension. -# -# * The order of rules is important: for each item, only the first matching -# rule is applied. -# -# * Item identifiers start and end with a slash (e.g. â/about/â for the file -# âcontent/about.htmlâ). To select all children, grandchildren, ⦠of an -# item, use the pattern â/about/*/â; â/about/*â will also select the parent, -# because â*â matches zero or more characters. - -passthrough /\/(bootstrap|css|font|img|js|static|guide|fonts|images|javascripts|stylesheets|subnavs)\/.*/ - -compile '/docs/**/*' do - @docs = true - filter :erb - layout '/docs.*' -end - -compile '/community/**/*' do - @community = true - filter :erb - layout '/community.*' -end - -compile '/releases/**/*' do - @releases = true - filter :erb - layout '/releases.*' -end - -compile '/**/*' do - if item.binary? - # donât filter binary items - else - filter :erb - layout '/default.*' - end -end - -route '/**/*.html' do - if item.identifier =~ '/index.*' - '/index.html' - else - item.identifier.without_ext + '.html' - end -end - -layout '/**/*', :erb http://git-wip-us.apache.org/repos/asf/geode/blob/da3767da/geode-site/website/build.sh ---------------------------------------------------------------------- diff --git a/geode-site/website/build.sh b/geode-site/website/build.sh deleted file mode 100755 index 00a9ed0..0000000 --- a/geode-site/website/build.sh +++ /dev/null @@ -1,18 +0,0 @@ -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -nanoc compile
