This is an automated email from the ASF dual-hosted git repository.
francischuang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/calcite-avatica.git
The following commit(s) were added to refs/heads/main by this push:
new 41c88bcac [CALCITE-6845] Self-host website images
41c88bcac is described below
commit 41c88bcac64be7cf8067360ac8ea1c1b604e2dc7
Author: Francis Chuang <[email protected]>
AuthorDate: Tue Feb 18 10:29:50 2025 +1100
[CALCITE-6845] Self-host website images
---
site/README.md | 54 +++++++-------------------------------
site/_docs/index.md | 2 +-
site/_includes/news_item.html | 2 +-
site/_layouts/news_item.html | 2 +-
site/img/avatica-architecture.png | Bin 0 -> 180905 bytes
5 files changed, 13 insertions(+), 47 deletions(-)
diff --git a/site/README.md b/site/README.md
index 24f7af736..5b031d8a3 100644
--- a/site/README.md
+++ b/site/README.md
@@ -28,59 +28,21 @@ You can build the site manually using your environment or
use the docker compose
The site is automatically built and published following the process outlined
in the [Calcite
repository](https://github.com/apache/calcite/blob/main/site/README.md).
-# Previewing the website locally
-
-## Building website on a host system
-
-### Setup your environment
-
-Similar to the instructions to
-[set up the Calcite web
site](https://github.com/apache/calcite-avatica/blob/main/site/README.md).
-
-Site generation currently works best with ruby-2.7.4.
-
-1. `cd site`
-2. `git clone https://gitbox.apache.org/repos/asf/calcite-site.git target`.
-The site will be generated to target/avatica, so it will be ready for commit.
-3. `sudo apt-get install rubygems ruby2.7-dev zlib1g-dev` (linux)
-4. `sudo gem install bundler`
-5. Add avatica-go content: `./add-avatica-go-docs.sh`
-6. `bundle install`
-
-### Build javadoc
-
-1. `cd $avatica_project_directory`
-2. `./gradlew javadocAggregate # the result is placed to
build/docs/javadocAggregate`
-
-### Running website locally
-
-Before opening a pull request, you can preview your contributions by
-running from within the directory:
-
-1. `bundle exec jekyll serve`
-2. Open [http://localhost:4000/avatica/](http://localhost:4000/avatica/) (note
the trailing slash)
-
-### Building the website
-
-1. `bundle exec jekyll build`
-2. The result is produced to `target/avatica`
-
-## Building website with Docker
-
-### Setup your environment
+# Previewing the website locally using docker
+## Setup your environment
1. Install [docker](https://docs.docker.com/install/)
-2. Install [docker compose
v2](https://docs.docker.com/compose/cli-command/#installing-compose-v2)
+2. Install [docker compose](https://docs.docker.com/compose/install/)
-### Build site
+## Build site
1. `cd site`
2. `docker compose run build-site`
-### Generate javadoc
+## Generate javadoc
1. `cd site`
2. `docker compose run generate-javadoc`
-### Running development mode locally
+## Running development mode locally
You can preview your work while working on the site.
1. `cd site`
@@ -89,3 +51,7 @@ You can preview your work while working on the site.
The web server will be started on
[http://localhost:4000/avatica/](http://localhost:4000/avatica/) (note the
trailing slash)
As you make changes to the site, the site will automatically rebuild.
+
+## Publishing the website
+The website is automatically published using GitHub Actions, so you do not
need to do anything but just merge your
+changes to the `main` branch.
diff --git a/site/_docs/index.md b/site/_docs/index.md
index 1cb29c419..e41823c05 100644
--- a/site/_docs/index.md
+++ b/site/_docs/index.md
@@ -25,7 +25,7 @@ limitations under the License.
Avatica is a framework for building JDBC and ODBC drivers for databases,
and an RPC wire protocol.
-
+
Avatica's Java binding has very few dependencies.
Even though it is part of Apache Calcite it does not depend on other parts of
diff --git a/site/_includes/news_item.html b/site/_includes/news_item.html
index f2fdcdc9c..97d71070e 100644
--- a/site/_includes/news_item.html
+++ b/site/_includes/news_item.html
@@ -41,7 +41,7 @@ <h2>
{% if c.avatar %}
{% assign avatar = c.avatar %}
{% else %}
- {% capture avatar %}http://github.com/{{ c.githubId }}.png{%
endcapture %}
+ {% capture avatar %}https://calcite.apache.org/img/avatars/{{
c.githubId }}.png{% endcapture %}
{% endif %}
{% endif %}
{% endfor %}
diff --git a/site/_layouts/news_item.html b/site/_layouts/news_item.html
index 8955729e2..56bfdd1aa 100644
--- a/site/_layouts/news_item.html
+++ b/site/_layouts/news_item.html
@@ -28,7 +28,7 @@ <h2>
{% if c.avatar %}
{% assign avatar = c.avatar %}
{% else %}
- {% capture avatar %}http://github.com/{{ c.githubId }}.png{%
endcapture %}
+ {% capture avatar %}https://calcite.apache.org/img/avatars/{{
c.githubId }}.png{% endcapture %}
{% endif %}
{% endif %}
{% endfor %}
diff --git a/site/img/avatica-architecture.png
b/site/img/avatica-architecture.png
new file mode 100644
index 000000000..57c73c96e
Binary files /dev/null and b/site/img/avatica-architecture.png differ
