You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@toree.apache.org by lr...@apache.org on 2020/08/02 20:29:34 UTC
[incubator-toree-website] 01/11: Update website README details
This is an automated email from the ASF dual-hosted git repository.
lresende pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-toree-website.git
commit 1c1b82667f22dc0651a2f791bc17a83b3883d332
Author: Luciano Resende <lr...@apache.org>
AuthorDate: Sun Aug 2 13:12:12 2020 -0700
Update website README details
---
README.md | 21 ++++++++++-----------
1 file changed, 10 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 52e386c..9a72331 100644
--- a/README.md
+++ b/README.md
@@ -17,10 +17,10 @@ limitations under the License.
{% endcomment %}
-->
-# Apache Website Template
+# Apache Toree Website
-This project contains a template web site that aims to follow all the various required
-Apache Website Policies.
+This project is used to generate the [Apache Toree](https://toree.apache.org) website
+and is based on the [Apache Website Template](https://github.com/apache/apache-website-template)
This template was generated using [Jekyll](https://jekyllrb.com/) 2.4.0.
@@ -30,17 +30,16 @@ your own project.
# How to deploy your project's web site
-(In the following instructions we assume that your project is called
-'Apache Foo'; search and replace with your actual project name.)
-
## Setup
```
1. cd site
-2. svn co https://svn.apache.org/repos/asf/foo/site target
-3. sudo apt-get install ruby-full build-essential zlib1g-dev
-4. sudo gem install bundler github-pages jekyll
-5. bundle install
+2. svn co https://svn.apache.org/repos/asf/incubator/toree/site target
+3. Jekyll requires ruby, more details on https://jekyllrb.com/docs/installation
+4. gem install --user-install bundler github-pages jekyll
+5. add local .gem directory to path
+5.1 echo 'export PATH="$HOME/.gem/ruby/X.X.0/bin:$PATH"' >> ~/.bash_profile
+6. bundle install
```
## Add javadoc
@@ -75,7 +74,7 @@ running from within the directory:
Within a few minutes, svnpubsub should kick in and you'll be able to
see the results at
-[foo.apache.org](https://foo.apache.org/).
+[foo.apache.org](https://toree.apache.org/).
## Adding contributors