Improve the UX and documentation of the website

[addihorowitz]

Following usability testing sessions, please make the following changes:

• Home page

  • “CDK8s is a Cloud Native Computing Foundation (https://www.cncf.io/) Sandbox Project“ - this entire area should be displayed first thing on the home page (not at the bottom).
  • Remove the “CDK for Kubernetes” area completely - the title, the get started button, the image. The website should start with the section below “Cloud Development Kit for Kubernetes... cdk8s is...”. Make sure the code sample is visible at a first glance.
  • Change “Define Kubernetes applications using familiar programming languages” to “Define Kubernetes applications using familiar programming languages. Utilize loops and conditions and built-in testing for your manifests!”
  • Change “Use the same tools to build your application and its configuration” to “Use the same programming language to build your application and its configuration”
  • Add the following comments (maybe we should improve the wording):
    • No need to have any registered account
    • No need to install Kubernetes, just install cdk8s and that’s it

• Getting Started

  • The instructions are a bit confusing - we start with pre-req by language, then installation instructions by a tool which is usually related to TS, then new project by programming language again. Perhaps we should just display it with a different UI, not as tabs but as text only.
  • Add comments to the pre-req to make sure people know:
    • No need for any registered account
    • No need to install Kubernetes nor to have running clusters
  • We should remove the "$" at the beginning of these lines. People copy the commands and get the "$" with the command (annoying)
  • ~Compile command is missing for TS users~

• Examples

  • Code samples should be displayed on the website. They do not expect to be redirected to GitHub. Change the text at https://cdk8s.io/docs/latest/examples/ to be “This section includes references for CDK8s and CDK8s+ examples on GitHub”
  • When a user looked at the samples he said “I wonder if code completion is supported for all languages. I’m not sure Python will have”. Can we add some clear information about it to the documentation?

[iliapolo]

It looks like according to CNCF guidelines, the logo and the CNCF statement should be located at the bottom of the page:

https://github.com/cncf/foundation/blob/master/website-guidelines.md

CNCF requests that graduated and incubating projects include the sentence “We are a Cloud Native Computing Foundation project.” and the CNCF logo near the bottom of their project homepage. Sandbox-level projects should include the sentence “We are a Cloud Native Computing Foundation sandbox project.” and the CNCF logo. We also appreciate a link to KubeCon + CloudNativeCon as the events approach.