jkube icon indicating copy to clipboard operation
jkube copied to clipboard

Refresh the JKube website and access to the documentation/Get started/quickstarts

Open sunix opened this issue 3 years ago • 1 comments

Description

The JKube website https://www.eclipse.org/jkube/ needs a refresh so new users, users and contributors find the doc or example for what they need quickly.

TBDiscuss - Suggestion of the outline of the main web page:

  • [x] Description + short video demo #1154
  • [x] List of options (gradle-k8s,gradle-oc,mvn-k8s,mvn-oc in columns with big icons + the lines to add to pom.xml/build.gradle + link to documentation + link to get started https://github.com/jkubeio/jkube-website/pull/53
  • [ ] Latest news! (could be a snapshot of JKube twitter)
  • [ ] Try with minikube/devsandbox/katacodas
  • [ ] Videos demos/talks other resource/sprint reviews
  • [ ] talk to us! contact gitter
  • [ ] Link to our contribution guide
  • [ ] Quickstarts show examples for Gradle + Maven (+ Kit) https://github.com/eclipse/jkube/issues/1050

sunix avatar Apr 06 '22 06:04 sunix

I was thinking about this, this morning too.

Regarding the Quickstarts page

The plan would be to improve (or migrate to adoc) the Markdown files located in the root of each quickstart. We should add some Frontmatter metadata to each, including the following:

  • slug
  • Short title (50-60 chars)
  • Short description (50-160 chars)
  • keywords
  • (type) <- inferred from directory location: kit, maven, gradle
  • framework keywords
  • (last updated date) <- Maybe we can use git for this

Then we can improve our custom GatsbyJS quickstart processor to analyze these files and create the quickstart index (already here), and a new page for each quickstart.

The index page might be improved with the following:

  • Present each quickstart in a nice card (would require a thumbnail)
  • Allow filtering: (Gradle|Maven), framework, free text search
  • Each card contains a link to a dedicated page for each quickstart

manusa avatar Apr 06 '22 07:04 manusa