Merge pull request #151 from openwhisk/docs/build-steps

Docs: add build steps to README
tree: a4be9bcaa826aa3ccaf1c54323b01a6527c7be24
  1. _includes/
  2. _layouts/
  3. _scss/
  4. bin/
  5. css/
  6. fonts/
  7. images/
  8. js/
  9. src/
  10. .babelrc
  11. .editorconfig
  12. .gitignore
  13. .jscsrc
  14. _config.yml
  15. about.md
  16. CNAME
  17. contact.md
  18. CONTRIBUTING.md
  19. contributors.md
  20. developers.md
  21. events.md
  22. faq.md
  23. Gemfile
  24. Gemfile.lock
  25. index.md
  26. integrations.md
  27. LICENSE.txt
  28. media.md
  29. package.json
  30. partners.md
  31. README.md
  32. rollup.config.js
  33. serverless.md
  34. service-integrators.md
README.md

Apache OpenWhisk Website

License ZenHub

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

NOTE: This site is built with Jekyll, so you‘ll need to run gem install jekyll if you don’t have it installed already.

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

# Move into the cloned repo.
cd openwhisk.github.io

# Start the development server.
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 repo 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.

License

Copyright 2016 IBM Corporation

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.

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.