Apache OpenWhisk Web Site

Clone this repo:
  1. 3f02de7 add .asf.yaml to configure github metadata (#412) by David Grove · 5 weeks ago master
  2. 624929d openwhisk-runtime-go 1.14.0 released (#411) by David Grove · 9 weeks ago
  3. 2f55843 move client-go to client library section of download pages (#410) by David Grove · 2 months ago
  4. a638d53 update downloads for openwhisk CLI group 1.0.0 (#409) by David Grove · 3 months ago
  5. 2a4ff56 release apigateway 0.11.0 (#408) by David Grove · 3 months ago

Apache OpenWhisk Website

License Build Status

Apache OpenWhisk is a cloud-first distributed event-based programming service. It provides a programming model to upload event handlers to a cloud service, and register the handlers to respond to various events.

Quickstart for Local Development

Install Prerequisites

# Verify Node and Node Package Manager are installed
node -v
npm -v

# Verify Ruby is installed
ruby -v

# Install Jekyll, which is used to build the site
gem install jekyll bundler

Clone and start development server

# Clone the repository (and correct branch).
git clone https://github.com/apache/openwhisk-website.git

# Move into the cloned repo.
cd openwhisk-website

# Install gem dependencies
bundle install

# Start the development server default location http://127.0.0.1:4000
bin/develop

Validate HTML, links and more

To make sure nothing is broken on the website we use html-proofer, it checks to see if any of the links 404s, if the HTML is valid, images have alt tags and more.

Run the following command to run html-proofer:

bin/test

How to Build Jekyll to Output Static Files

If you need to generate static files, run the following:

# NOTE: Make sure you have already cloned the repository and moved into the directory.

# Build the site.
bundle exec jekyll build

This will build static files to a directory called _site/ in the project root. This can be used for manual deployment to a static server or with build tools like Jenkins.

Updating CSS files

Some browsers will continue to use cached copies of “.css” files even though the styles/content in the files has changed significantly. If you make any changes that affect layout, you SHOULD increment the (artificial) version number on the query parameter on the <link> within default.html which will cause (force) some clients to pull down a new main.css file (and all the cascading CSS imports as well):

<link rel="stylesheet" href="{{ site.github.url }}/css/main-v1.css?v=1.12">

for example, update “?v1.12” to “?v1.13”.

<link rel="stylesheet" href="{{ site.github.url }}/css/main-v1.css?v=1.13">

Troubleshooting

If you get an error ‘bundle: command not found’ attempting to build the site, you may need to manually install the ‘bundler’ package:

 gem install bundler

Jenkins build

The OpenWhisk.org website is automatically built and published to Apache at: https://openwhisk.apache.org/

Current Jenkins build status can be checked here: https://builds.apache.org/job/OpenWhisk-website/

Issues

Report website bugs, ask questions and request features here on GitHub.

You can also join our slack domain and chat with developers. Please visit here to sign up: https://openwhisk.apache.org/slack.html

License

Licensed under the Apache License, Version 2.0 (the “License”).

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.