Page History

We would like to simplify existing OpenWhisk website http://openwhisk.incubator.apache.org/ so that its easier to navigate and consume.

Current Home Page:

Documentation

• Have user identify themselves as one of the following roles (i.e., user or developer), take them to that subsection and allow themselves to further identify themselves

• Roles

• Users

• End users (run functions using CLI, wskdeploy, tooling)

• Operators (install, deploy, configure, admin)

• links to docs. on deployments (Kube, Mesos, Compose), wkadmin, etc.

• Developers

• Function (incl. packages)

• Integrators (database, log, plug-ins, etc.)

• Runtime

• SDK -> new runtimes

• Backend

• Controller (Load balancer, Invoker, Kafka, etc.)

• Tooling

• eskdeploy CLI/clients/etc.

• Contributors (Developer ++)

• includes testing, reviewing PRs, etc.

• how to become a Contributor (reference CWIKI, duplicate info as needed)

• how to become a Committer (reference CWIKI, duplicate info as needed)

• Link to Community (i.e., "dev" list, Slack, GitHub issues.

Community

---

Menu on the top right has following items:

• Docs:

• Page: About: http://openwhisk.incubator.apache.org/about.html

• STRATEGY:  RELOCATE DATA & DELETE

• move information to Home page and/or Documentation page

• Section: What is Apache OW?

• ACTION: MOVE

• Moving it to Home Page with a refreshed architecture diagram.

• Would like the majority of this info on the Home page.

• Paragraph: "Package creators":  Need to assure we preserve this "role" in some form...

• http://openwhisk.incubator.apache.org/package-creators

• Perhaps wherever we establish those roles on the main "docs" page

• -> DOCUMENTATION page (Roles, TBD)

• Paragraph: "Contributors" - Need to assure we preserve this "role" in some form...

• http://openwhisk.incubator.apache.org/contributors

• Perhaps wherever we establish those roles on the main "docs" page

• -> DOCUMENTATION page (Roles, TBD)

• Section: High Level Programming Model

• ACTION: MOVE & UPDATE

• Revised architecture diagram on Home page

• Some of the content is merged with "What is OW" section on Home Page.

• Moving explanation of "Event Sources, Triggers, Actions, Rules, Sequences, and Packages" under Documentation section directly referring from main GitHub repo https://github.com/apache/incubator-openwhisk/docs/README.md#programming-model. 

• Page: Serverless: http://openwhisk.incubator.apache.org/serverless.html

• STRATEGY:  DELETE

• We should not be trying to define Serverless at this point in time... other sites can choose to define this better than us...

• Page: FAQ: http://openwhisk.incubator.apache.org/faq.html

• STRATEGY:  DELETE

• The entirety of the information either tries to provide more definitions for Serverless, differentiate FaaS from PaaS, point to Blu-mix, or one of the social or community links

• Information is redundant at best

• Page: Documentation: https://github.com/apache/incubator-openwhisk/tree/master/docs#readme 

• STRATEGY: REDESIGN

• Provide comprehensive links to existing markdown in GitHub Repos.

• Define Roles and co-locate / organize information around these roles

• Cultivate content from Medium/repo. eternal-resources

• Menu item: Get Started:

• Page: Developers: http://openwhisk.incubator.apache.org/developers.html

• ACTION: MOVE to Home page (as button) takes you to GitHub markdown

• Section: Scaling Per-Request & Optimal Utilization - 

• MOVED - Moved to Home Page

• Section: Flexible Programming 

• MOVED - Renamed to Write functions in any language and moved to Home Page

• Section: Rich Service Ecosystem 

• DELETED (REDUNDANT)

• intuited from Home page section

• Button: Join Our Mailing List

• REDUNDANT: Referenced on Community Page

• Button: Explore the Source on GitHub 

• REDUNDANT: Referenced on Community Page

• Quotes:

• Move under Community

• “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 

• “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

• TODO: Discuss on "dev" list on what to do with these "Supporter" quotes as these are based upon being IBM Cloud Functions customers...

• Contributors: http://openwhisk.incubator.apache.org/contributors.html

• ACTION: MOVE & UPDATE: 

• Move to Community page and link to project CWiki

• The CWiki defines process to become a contributor

• Quotes:

• Move under Community

• "So far I find #OpenWhisk the real highlight of this #serverlessconf London, I’m totally amazed by the work done so far by the dev team! kudos”  -  #OpenWhisk 

•  2nd auote from #OpenWhisk ... (can't copy and paste for some reason)

• Package Creators: http://openwhisk.incubator.apache.org/package-creators.html

• ACTION: MOVE & UPDATE: 

• Move under Community

• Button: Add Your Package Now: https://github.com/apache/incubator-openwhisk/blob/master/docs/packages.md

• MOVED Moving to Documentation Page

• Build a community of developers around your service.

• DELETED (REDUNDANT)

• Unlock unlimited third-party integrations.

• DELETED (REDUNDANT)

• Join a growing ecosystem of package creators.

• DELETED (REDUNDANT) 

• Quotes: Quote 1 Quote 2     

• Move under Community

•   DELETED (REDUNDANT) – André Poleza, Co-Founder of Nepente 

• The quote from CTO of Altoros (typo) can be moved)

• Community:

• Mailing Lists: http://openwhisk.incubator.apache.org/contact.html

• Contact info moved to Community

• dev-subscribe@openwhisk.incubator.apache.org

• dev-unsubscribe@openwhisk.incubator.apache.org

• dev@openwhisk.incubator.apache.org

• To see existing messages, check out the archive.

• Wiki: https://cwiki.apache.org/confluence/display/OPENWHISK/OpenWhisk+Project+Wiki

• Moved to Community Page

• Social Media: http://openwhisk.incubator.apache.org/social

• Moved to Community Page

• The OpenWhisk mailing list is primarily for contributor discussions around the Apache project. There are several other channels also available for general interest and end user developer questions.GitHub: Browse the OpenWhisk source code, documentation, and ecosystem of supporting projects.

• YouTube: See demos of OpenWhisk in action.

• SlideShare: Look over slides from many of the presentations from past events.

• Twitter: Follow for the latest news from the OpenWhisk ecosystem.

• Stack Overflow: Ask questions and find answers about how to use OpenWhisk.

• Slack: Engage the OpenWhisk developers directly in conversations.

• Medium: Read blog posts about OpenWhisk use cases and underlying architecture.

• Events: http://openwhisk.incubator.apache.org/events.html

• TODO: Stale list (not maintained)

• Change to "historical" list somewhere, leverage "incubator-openwhisk-external-resources" markdown & automate FORM submission -> PPMC approval (email) and -> merge to Markdown (somehow, via Actions?)

• Supporters: http://openwhisk.incubator.apache.org/supporters.html

• Preserve on Community (for now) and ad IBM (Cloud functions)  (use this link https://www.ibm.com/cloud/functions)

• Blog: https://medium.com/openwhisk

• Moved to Community

• Resources:

• Integrations: https://github.com/apache/incubator-openwhisk-external-resources#feed-providers

• Moving it to Documentation

• Demos & Examples: https://github.com/apache/incubator-openwhisk-external-resources#applications

• Moving it to Documentation

• Articles: https://github.com/apache/incubator-openwhisk-external-resources#articles

• Moving it to Documentation

• Tutorials: https://github.com/apache/incubator-openwhisk-external-resources#tutorials

• Moving it to Documentation

---

List of HTML Pages which are not linked in the menu:

• http://openwhisk.incubator.apache.org/slack.html

• MOVED to Community Page

Current Home Page:

• Get Started Button: https://github.com/apache/incubator-openwhisk/tree/master/docs#getting-started-with-openwhisk

• Where to start - OpenWhisk CLI - GIF

• How do I use Apache OpenWhisk? Focus only on your code: http://openwhisk.incubator.apache.org/developers

• How do I integrate my service with Apache OpenWhisk? Plug your service into Apache OpenWhisk: http://openwhisk.incubator.apache.org/developers

• How can I contribute to Apache OpenWhisk? Join a vibrant open source community: http://openwhisk.incubator.apache.org/contributors

Proposed Home Page:

 

• Create your Local Playground Button: https://github.com/apache/incubator-openwhisk#quick-start

• Focus only on your code - Create Your First Action: https://github.com/apache/incubator-openwhisk/blob/master/docs/actions.md

• Runtime Support: Links to all the runtimes supported like:

• https://github.com/apache/incubator-openwhisk-runtime-nodejs

• https://github.com/apache/incubator-openwhisk-runtime-swift

• https://github.com/apache/incubator-openwhisk-runtime-go

• https://github.com/apache/incubator-openwhisk-runtime-java

• https://github.com/apache/incubator-openwhisk-runtime-docker

• https://github.com/apache/incubator-openwhisk-runtime-python

• https://github.com/apache/incubator-openwhisk-runtime-php

• High Level Programming Models & Compositions

• Scaling Per-Request & Optimal Utilization

• Plug your service into Apache OpenWhisk

• Easy as 1-2-3

• Join a vibrant open source community

Other considerations

• Preserve existing "Supporters" pages, need to verify list for currency

• NEED TO ADD IBM (and avoid legal issues)

• Code patterns in lieu of "Case Studies"

• Perhaps at some future date we can get IBM/Adobe/RedHat to submit and maintain (not mnow)