apache / openwhisk-website

Apache OpenWhisk website (openwhisk.apache.org) content; built using Jekyll
https://openwhisk.apache.org/
Apache License 2.0
21 stars 50 forks source link

Lower the barrier to getting started as quickly as possible as a developer #56

Closed krook closed 3 years ago

krook commented 7 years ago

Ideas:

jthomas commented 7 years ago

I know @mrutkows had someone working on a clone of the interactive Docker tool for OpenWhisk. https://github.com/openwhisk/openwhisk-tutorial

It was running at https://learnwhisk.mybluemix.net/#0 but it wasn't clear whether this was a permanent URL.

It's a brilliant tool.

jthomas commented 7 years ago

I think having a "Getting Started" page rather than linking straight into the open-source docs would make an easy onboarding experience.

Here’s my ideal on-boarding flow….

  1. “Set Up OpenWhisk” —> Links to deployment instructions or list of providers.
  2. “Set Up Developer Tools” —> Users should be given a link to the CLI binary they can install without compiling anything.
  3. “Set up credentials” —> Show CLI command to set up platform properties.
  4. “Hello World” example —> Simple steps to use the example listed in the docs

The Bluemix docs for the CLI are a good example steps 2 & 3 (https://console.ng.bluemix.net/openwhisk/cli).

jlengstorf commented 7 years ago

@jthomas I love this, and I fully agree that having some kind of interactive quickstart would be far superior to dropping someone into the docs.

I don't know how runway-ready learnwhisk.mybluemix.net is, but assuming it's usable I think putting it on learn.openwhisk.org (or something similar) would be a fantastic addition to the site.

jlengstorf commented 7 years ago

Most users will be interested in technical features — we need to make sure that's accessible and prominent.