Coder Social home page Coder Social logo

apache / openwhisk-website Goto Github PK

View Code? Open in Web Editor NEW
21.0 40.0 50.0 42.5 MB

Apache OpenWhisk website (openwhisk.apache.org) content; built using Jekyll

Home Page: https://openwhisk.apache.org/

License: Apache License 2.0

HTML 80.01% JavaScript 3.75% Ruby 1.72% Shell 0.31% Groovy 0.51% Java 0.16% Go 0.12% PHP 0.07% Python 0.07% Swift 0.08% C# 0.18% SCSS 13.03%
openwhisk apache serverless faas functions-as-a-service cloud serverless-architectures serverless-functions docker kubernetes

openwhisk-website's Introduction

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">

Using rbenv

If you need to maintain your existing system Ruby version, you can use the https://github.com/rbenv/rbenv utility to dynamically switch to the version this project requires.

The project already has a .ruby_version file which indicates it requires Ruby 2.7.2. All you need do is assure once rbenv is installed that you issue the following commands (one time) from the bash shell you wish to compile the project:

$ rbenv init
$ rbenv install 2.7.2
$ rbenv global 2.7.2
$ eval "$(rbenv init -)"

When opening subsequent bash terminals, you need only issue the following command (as rbenv init has updated your system .bash_profile):

eval "$(rbenv init -)"

You can verify the version changed by using:

$ rbenv global
$ ruby -v

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.

openwhisk-website's People

Contributors

akrabat avatar andreasnauerz avatar broerse avatar buggtb avatar csantanapr avatar dgrove-oss avatar e-moe avatar ellenwyllie avatar jbampton avatar jlengstorf avatar jthomas avatar juice10 avatar krook avatar kun-song avatar michaelmarth avatar mpmunasinghe avatar mrutkows avatar pritidesai avatar rabbah avatar rvlieshout avatar sciabarracom avatar shawnallen85 avatar style95 avatar tahmina-ahmed avatar tardieu avatar tokida avatar vibhuti019 avatar yadunandanbhat avatar yasinghcse avatar yiyiyimu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

openwhisk-website's Issues

Review FAQ Links

We need to review the FAQ Questions and Answers. Bluemix is everywhere and we might want to change.

Create illustrations for the Contributors page.

Currently blocked by #29. Once we get the content, we need the following from @yumeforever:

  • Illustration for section 1
  • Illustration for section 2
  • Illustration for section 3

(We should update these todos with actual feature/section headlines once we have them.)

Need to create process for adding materials to linked social media sites

It should be clear how content can be added to OpenWhisk social media accounts.

That includes adding the relevant collaboration users to those accounts, or at least defining how content can be suggested to someone with access.

This would include adding videos to YouTube, adding presentations to SlideShare, articles to Medium, etc.

Maybe a FAQ item describes the recommended process?

Create a new video for the home page.

Currently we have a placeholder from the OpenWhisk YouTube channel.

  • Record a new video to be played on the home page. (@nauerz-ibm)
  • Write a script for the video (@nauerz-ibm)
  • Add voice-over to the new video (@krook)
  • Replace the current video on the home page (@jlengstorf)

Update FAQ link list style.

Per @yumeforever:

For the question I would use:
links:

text-decoration: none;
color: #29648F;
font-size: 18px;

and no margin on the left
hover:
text-decoration: underline; (I guess)

Choose pull quotes for Service Integrators page (2).

  • Choose 10–25 words of praise or review from two reviews
  • Provide citation (name, source link, publication)

If possible, it would be great to include an avatar or publication logo. See #21 for discussion about legality of doing so.

Edit content for Service Integrators panel of the home page.

From @nauerz-ibm:

How about this (pls rephrase a bit, 1st sentence is too long):

OpenWhisk relies on an open ecosystem of services provided by different vendors and falling into
different domains like analytics, cognitive, data, IoT, and mobile. These services represent
powerful building blocks - fostering re-use and avoiding reinventing the wheel, hence accelerating
overall development - providing totally different capabilities developers can make use of to build
compelling serverless event-driven solutions.

Evem better, OpenWhisk provides an open event provider interface that allows it everybody to let
his own service become part of OpenWhisk’s ecosystem to drive traffic & usage.

Color Change on About Page

I just revisited the About Page with the new informations and realized it was still following the previous color patterns.

First section background color is: #F0F8FD
Last section: #FFFFFF

Following reference:
about 2x

Choose pull quotes for Developers page (2).

  • Choose 10–25 words of praise or review from two reviews
  • Provide citation (name, source link, publication)

If possible, it would be great to include an avatar or publication logo. See #21 for discussion about legality of doing so.

Choose pull quotes for home page (2).

  • Choose 10–25 words of praise or review from two reviews
  • Provide citation (name, source link, publication)

If possible, it would be great to include an avatar or publication logo. @krook @mrutkows who do we need to ask to make sure it's legal to do that?

Choose pull quotes for Contributors page (2).

  • Choose 10–25 words of praise or review from two reviews
  • Provide citation (name, source link, publication)

If possible, it would be great to include an avatar or publication logo. See #21 for discussion about legality of doing so.

Review README

I haven't touched the README from the original OpenWhisk site. Does this need to be updated with Apache branding, new license, etc.?

Write lede + 3 feature overview sections for Contributors page.

Initial ideas from @nauerz-ibm:

Serverless computing is already showing its potential to become a game-changer for cloud-native application development.

Are you interested to become part of a strong community & work on a bleeding edge technology?

It does not matter whether you are an application developer, a service integrator or someone keen to help us working on the core engine itself. We welcome everybody willing to help…

If you are an application developer show us what you have already build or what you plan to build with OpenWhisk and we will promote your solution within our community so you can get feedback for free to make your solution even better. We even welcome you to share your rules, actions, and triggers and – in return – benefit from others doing the same preventing people from reinventing the wheel.

If you are a service integrator you should definitely consider enabling your service for OpenWhisk to let it become part of a growing ecosystem. Being part of our ecosystem will make your service more attractive to other developers building OpenWhisk-based serverless & event-driven solutions. This will drive traffic & usage of your service.

If you are an open-source contributor working with us is your chance to learn something new & broaden your skillset. Help us to drive & accelerate the development of this technology. Help us proposing or even adding more cool features. Start participating today - in something that itself has been built upon open technologies like Scala, Docker, Consul, Kafka…

In any case: We are looking forward to hear about your ideas and benefit from your contributions. Join the community and become part of the OpenWhisk game.

Finish Serverless page.

  • Update content
  • Create illustration (@yumeforever)
  • Add illustration
  • Choose pull quote w/citation and link
  • Add use cases

@yumeforever, once you've got the illustration, please add it here and assign this to me. I will knock the rest of these out.

Edit About page.

  • Edit copy for main section.
  • Edit copy for Architecture Overview section.
  • Swap out video with the one chosen in #27.

Add SEO meta tags for the site.

  • Write a title that's SEO-friendly
  • Write a description that's SEO-friendly
  • Add SEO tags for sharing (Google, OpenGraph, Twitter)
  • Request Twitter cards verification

Create content for the Imprint page.

There is an "Imprint" page in the footer nav at the moment.

  • Confirm whether or not this page is legally required.
  • Write content for the page.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.