This is an automated email from the ASF dual-hosted git repository. rzo1 pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-stormcrawler-site.git
commit 1505fb17036232a63c854c7a128526fcccc344a7 Author: Richard Zowalla <[email protected]> AuthorDate: Mon Apr 15 21:25:24 2024 +0200 Adds docker-compose to build locally. Updates README. --- Gemfile | 4 ++++ _config-local.yml | 17 +++++++++++++++++ _includes/footer.html | 2 +- css/main.scss | 1 - docker-compose.yml | 20 ++++++++++++++++++++ readme.md | 10 ++++++++++ 6 files changed, 52 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..701a330 --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source "https://rubygems.org"; + +gem "jekyll", "~> 3.9.3" +gem "webrick", "~> 1.7", platforms: :ruby \ No newline at end of file diff --git a/_config-local.yml b/_config-local.yml new file mode 100644 index 0000000..4b53b56 --- /dev/null +++ b/_config-local.yml @@ -0,0 +1,17 @@ +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely need to edit after that. +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'jekyll serve'. If you change this file, please restart the server process. + +# Site settings +title: Apache StormCrawler +email: [email protected] +description: > # this means to ignore newlines until "baseurl:" + Apache StormCrawler is collection of resources for building low-latency, scalable web crawlers on Apache Storm +baseurl: "" # the subpath of your site, e.g. /blog +url: "http://localhost:4000"; # the base hostname & protocol for your site + +# Build settings +markdown: kramdown diff --git a/_includes/footer.html b/_includes/footer.html index ecf3f68..1d59750 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -6,6 +6,6 @@ <footer class="site-footer"> © 2024 <a href="https://stormcrawler.apache.org/";>The Apache Software Foundation</a> -<p>Licensed under the Apache License, Version 2.0. Apache StormCrawler, TomEE, StormCrawler, the Apache feather logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> +<p>Licensed under the Apache License, Version 2.0. Apache StormCrawler, StormCrawler, the Apache feather logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> </footer> diff --git a/css/main.scss b/css/main.scss index 7b54644..52347e4 100644 --- a/css/main.scss +++ b/css/main.scss @@ -1,5 +1,4 @@ --- -# Only the main Sass file needs front matter (the dashes are enough) --- // Charset diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..83e05ca --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,20 @@ +services: + local: + image: jekyll/jekyll:latest + profiles: ["local"] + volumes: + - .:/srv/jekyll + ports: + - "4000:4000" + command: jekyll serve --watch --force_polling -config config-local.yml + + build: + image: jekyll/jekyll:latest + profiles: ["build"] + volumes: + - .:/srv/jekyll + command: jekyll build + +volumes: + jekyll_data: + driver: local \ No newline at end of file diff --git a/readme.md b/readme.md index 3b03fa0..1926d0d 100644 --- a/readme.md +++ b/readme.md @@ -5,6 +5,16 @@ This website is build using Jekyll. Make sure to have it available locally. To build and run server locally type 'jekyll serve'. The site can then be accessed at localhost:4000. +### Docker + +You can build the website for local testing by running + +```bash +docker compose up local +``` + + + ## Deployment This website uses the typical ASF layout. The actual website is found on `asf-site`. Any changes need to be pushed to this branch. \ No newline at end of file
