[libcloud-site] 02/03: Update readme.

[to...@apache.org]

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

tomaz pushed a commit to branch asf-staging
in repository https://gitbox.apache.org/repos/asf/libcloud-site.git

commit 3e98efe7e0454bab9a551f8ea103c2594a162bb2
Author: Tomaz Muraus <to...@tomaz.me>
AuthorDate: Tue Mar 29 23:32:49 2022 +0200

    Update readme.
---
 README.md | 50 +++++++++++++++++++++++++++++---------------------
 1 file changed, 29 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index e9334b2..95340d3 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,38 @@
-# Libcloud Website
+# Apache Libcloud Website
 
 This repository contains source code for a Libcloud website powered by
 [Jekyll][1].
 
-Note: Jekyll setup is based on my [blog's jekyll setup][2].
-
 ## System Dependencies
 
-* Ruby >= 1.9 <= 2.1
-* Gems: `bundler` (gem install bundler -v "1.3.0")
+* Ruby >= 3.1.1
+* Jekyll >= 4.2.2
+* Gems: `bundler` (gem install bundler)
 * jpgoptim (optional, for compressing images)
 * optipng (optional, for compressing images)
 * Node.js (optional, needed for Grunt tasks)
 
-Note: Since the version of Jekyll we use only works with some older Ruby versions,
-you are encouraged to install and use [rvm](https://rvm.io/) and use rvm to install
-Ruby v1.9.3 as shown below.
+You are strongly encouraged to utilize provided Dockerfile which contains
+all the dependencies which makes building the website a breeze.
+
+Keep in mind that the initial image build may take a while since all the
+dependencies need to be installed and build, but subsequent runs should be
+much faster.
+
+In case you want to install all the dependencies locally outside the Docker
+container, you are encouraged to install and use [rvm](https://rvm.io/)
+and use rvm to install Ruby as shown below.
 
 ```bash
-rvm install 1.9.3
-rvm use 1.9.3
-gem install bundler -v "1.3.0"
+rvm install 3.1.1
+rvm use 3.1.1
+gem install bundler -v "2.3.0"
 ```
 
 ## Installing Ruby dependencies
 
 ```bash
-rvm use 1.9.3
+rvm use 3.1.1
 bundle install
 ```
 
@@ -45,22 +51,24 @@ node_modules/.bin/grunt lint
 ## Running Local Development Server
 
 ```bash
+docker-run-dev-server.sh
 ./scripts/run-dev-server.sh
+# Non-Docker versions
+#./scripts/run-dev-server.sh
 ```
 
-## Generating and Publishing the Website
+This will start Docker container with local development server listening on port
+4000 available at http://localhost:4000/.
+
+## Building and Publishing the Website
 
 ```bash
-./scripts/generate_site.sh
+./scripts/docker-build-site.sh
+# Non-Docker versions
+#./scripts/docker-build-site.sh
 ./scripts/stage-changes.sh
-svn add source/*
-svn add generated/*
-svn commit generated/ -m "Generate website"
+git push origin <branch>
 ```
 
-Note: ``svn add source/*`` step is important - if you don't commit source files
-for the changes you made, your changes will get overwritten next time someone
-else re-generates the website.
-
 [1]: http://jekyllrb.com/
 [2]: https://github.com/Kami/kami.github.com