pritidesai/openwhisk-website

Apache OpenWhisk Website

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

• Download and install Node.js: see https://nodejs.org/
• Download and install Ruby: see https://www.ruby-lang.org/en/documentation/installation/

# 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/incubator-openwhisk-website.git

# Move into the cloned repo.
cd incubator-openwhisk-website

# Install gem dependencies
bundle install

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

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.

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: http://openwhisk.incubator.apache.org/

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

Issues

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

You can also join our slack channel and chat with developers. To get access to our slack channel, please see the instructions here.

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.

openwhisk-website's Issues

Catalog - Replace Apache Copyright

Please replace the longer Copyright in https://github.com/apache/incubator-openwhisk-catalog/blob/master/packages/samples/hello/python/hello.py to shorter like, https://github.com/apache/incubator-openwhisk-catalog/blob/master/packages/samples/hello/javascript/hello.js

// Licensed to the Apache Software Foundation (ASF) under one or more contributor
// license agreements; and to You under the Apache License, Version 2.0.

Create Logos webpage

We would like to have a page with variety of logos, similar to beam:

https://beam.apache.org/community/logos/

Develop Logo/Trademark policy and page

We should author the official policy on the Wiki (and allow comments from "dev" list), but can draft and prepare a page for it on the website as well. In addition, we should show all the approved logos and describe request process (i.e., provide a template in lieu of a FORM) that can be sent to our "private" PPMC email list to request various usages for conferences/tradeshows.

Like what NodeJS did: https://nodejs.org/en/about/trademark/

could look to draft some rough variant of the text along with request template/process.

Remove "OpenWhisk" from Documentation page title (redundant)

Add Quotes to Community Page

Quote 1:

“Apache OpenWhisk relieved us from all of our pain points. It allowed us to focus on coding instead of operational aspects, guaranteed optimal utilization and scaling, [and] provided us with a flexible programming model.”

– Barry Nijenhuis, SiteSpirit

Quote 2:

“Apache OpenWhisk’s modular and effective ecosystem twisted our minds and now we’re able to deploy and connect different parts of our apps and infrastructure easily.”

– André Poleza, Co-Founder of Nepente

Footer Updates

Please update footer for:

1. Add Apache Incubator logo in footer
2. Enlarge the text of the footer

Documentation scrolls horz. on small media

There should be a better way to wrap the Content text, but allow for scrolling only on the code samples. That is, you should not need to scroll on a mobile phone to read the majority of the developer/operator/contrib. documentation.

Need to provide links/method to point to releases

It is an Apache requirement, now that we have an official release, to provide the link to it (and future releases) from our project website. We need a methodology to do so; I would prefer deriving a dynamic list in a widget/frame on along the right column of the main page (and plan to include other widgets above/below it) without taking up too much vertical space.

Having said this preference, we have spent lots of time to assure that the CSS layouts work on tablets and even phone form factors. We need a solution that scales with at least these 3 appx. screen size in mind.

Update workshop

We have a workshop under apache at https://github.com/apache/incubator-openwhisk-workshop. Please update this workshop based on the latest material from https://github.com/jthomas/openwhisk-workshops.

Add Quotes (somewhere) and remove old pages

a) Extract quotes from these pages:
_layouts/developers.html
_layouts/creators.html
_layouts/contributors.html

and move to a file under _includes/partial and import it where we will use it.

b) create a single slideshow on some page (home?) using this quote widget.
c) then delete the old pages.
d) look to delete anonymous quotes (e.g., from Twiiter)
e) look to add new quotes from "Supporters" and partners at Apache. (perhaps solicit on "Dev" list or directly).

Add link to the dev mailing list

Create README Templates for Deployment methods

We would like to link every deployment README to openwhisk website documentation page. And to provide a uniform experience throughout all deployment methods, create a common template so that every deployment repos can change its README.md based on that template.

Add HelloWorld sample action

https://github.com/apache/incubator-openwhisk-catalog/tree/master/packages/samples/hello has hello world sample action in four runtimes:

• NodeJS
• Java
• Python
• Swift

Please add similar examples in following additional runtimes:

• Docker
• Go
• PHP

Add supporters "collage" at bottom of home page (work towards case studies)

Highlight CWIKI link

Add link to OpenWhisk cwiki page, please identify appropriate location and add it.