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
- End users (run functions using CLI, wskdeploy, tooling)
- Operators (install, deploy, configure, admin)
- links to docs. on deployments (Kube, Mesos, Compose), wkadmin, etc.
- Function (incl. packages)
- Integrators (database, log, plug-ins, etc.)
- Controller (Load balancer, Invoker, Kafka, etc.)
- 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:
- STRATEGY: RELOCATE DATA & DELETE
- move information to Home page and/or Documentation page
- Section: What is Apache OW?
- 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...
- 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...
- Perhaps wherever we establish those roles on the main "docs" page
- -> DOCUMENTATION page (Roles, TBD)
- Section: High Level Programming Model
- Revised architecture diagram on Home page
- Some of the content is merged with "What is OW" section on Home Page.
- We should not be trying to define Serverless at this point in time... other sites can choose to define this better than us...
- 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
- 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
- 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
- intuited from Home page section
- REDUNDANT: Referenced on Community Page
- REDUNDANT: Referenced on Community Page
- “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...
- Move to Community page and link to project CWiki
- The CWiki defines process to become a contributor
- "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)
- MOVED Moving to Documentation Page
- Build a community of developers around your service.
- Unlock unlimited third-party integrations.
- Join a growing ecosystem of package creators.
- DELETED (REDUNDANT) – André Poleza, Co-Founder of Nepente
- The quote from CTO of Altoros (typo) can be moved)
- Contact info moved to Community
- 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.
- 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?)
- Moving it to Documentation
- Moving it to Documentation
- Moving it to Documentation
- Moving it to Documentation
---
List of HTML Pages which are not linked in the menu:
Current Home Page:
- Where to start - OpenWhisk CLI - GIF
Proposed Home Page:
- Runtime Support: Links to all the runtimes supported like:
- High Level Programming Models & Compositions
- Scaling Per-Request & Optimal Utilization
- Plug your service into Apache OpenWhisk
- 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)