Skip to content
This repository has been archived by the owner on Jan 3, 2022. It is now read-only.

Commit

Permalink
Create a 'Getting Started' landing page
Browse files Browse the repository at this point in the history
The excerpts could use another pass in this new context.

- pinned the theme version since master was erroring
- add `/docs/getting-started/`
  - includes links and a summary of each getting started guide
  - managed automatically by the 'getting-started' doc category
  - redirect `/docs/` here until we have more docs
- updated current doc links to be `/docs/getting-started/{env}`
  - retained redirects for previous URLs

Fixes #42
  • Loading branch information
scothis authored and jldec committed Oct 7, 2018
1 parent 4be8338 commit 1946da7
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 13 deletions.
2 changes: 1 addition & 1 deletion _config.yml
@@ -1,4 +1,4 @@
remote_theme: "mmistakes/minimal-mistakes"
remote_theme: "mmistakes/minimal-mistakes@4.13.0"
plugins:
- jekyll-remote-theme
- jekyll-redirect-from
Expand Down
6 changes: 3 additions & 3 deletions _data/navigation.yml
Expand Up @@ -15,9 +15,9 @@ main:
# documentation links
docs:
- title: Getting Started
url: /docs/getting-started/
children:
- title: "on GKE"
url: /docs/getting-started-with-knative-riff-on-gke/
url: /docs/getting-started/gke/
- title: "on minikube"
url: /docs/getting-started-with-knative-riff-on-minikube/

url: /docs/getting-started/minikube/
22 changes: 22 additions & 0 deletions _docs/020-getting-started.md
@@ -0,0 +1,22 @@
---
layout: doc
title: "Getting started"
permalink: /docs/getting-started/
excerpt: "How to run Knative using **riff**"
header:
overlay_image: /images/sunrise.jpg
overlay_filter: 0.3
overlay_color: "#333"
redirect_from:
- /docs/
---

# Pick your environment

While riff should work in any certified Kubernetes environment, we actively test with these environments:

{% for doc in site.docs %}
{% if doc.categories contains 'getting-started' %}
{% include archive-single.html post=doc title=doc.short_title %}
{% endif %}
{% endfor %}
@@ -1,14 +1,18 @@
---
layout: doc
title: "Getting started on GKE"
permalink: /docs/getting-started-with-knative-riff-on-gke/
short_title: on GKE
permalink: /docs/getting-started/gke/
excerpt: "How to run Knative using **riff** on Google Kubernetes Engine"
header:
overlay_image: /images/gke.png
overlay_filter: 0.4
overlay_color: "#555"
redirect_from:
- /docs/
- /docs/getting-started-on-gke/
- /docs/getting-started-on-gke/
- /docs/getting-started-with-knative-riff-on-gke/
categories:
- getting-started
---

# Getting started on GKE
Expand Down
@@ -1,15 +1,20 @@
---
layout: doc
title: "Getting started running on Minikube"
permalink: /docs/getting-started-with-knative-riff-on-minikube/
short_title: on Minikube
permalink: /docs/getting-started/minikube/
excerpt: "How to run Knative using **riff** on Minikube"
header:
overlay_image: /images/minikube2.png
overlay_filter: 0.4
overlay_color: "#555"
redirect_from:
- /docs/getting-started-on-minikube/
- /docs/getting-started-on-docker-ce-edge-for-mac/
- /docs/getting-started-on-docker-ce-edge-for-windows/
- /docs/getting-started-on-minikube/
- /docs/getting-started-with-knative-riff-on-minikube/
- /docs/getting-started-on-docker-ce-edge-for-mac/
- /docs/getting-started-on-docker-ce-edge-for-windows/
categories:
- getting-started
---

# Getting started on Minikube
Expand Down
13 changes: 11 additions & 2 deletions _includes/archive-single.html
@@ -1,15 +1,24 @@
{% comment %}
from https://github.com/mmistakes/minimal-mistakes/blob/dcdbba835ccec00303cef87cbc1efe5c89cf5ed6/_includes/archive-single.html
modified to allow for youtube video embeds
modified to allow for:
- youtube video embeds
- custom post inlucde arg
- custom title
{% endcomment %}

{% if include.post %}
{% assign post = include.post %}
{% endif %}

{% if post.header.teaser %}
{% capture teaser %}{{ post.header.teaser }}{% endcapture %}
{% else %}
{% assign teaser = site.teaser %}
{% endif %}

{% if post.id %}
{% if include.title %}
{% assign title = include.title %}
{% elsif post.id %}
{% assign title = post.title | markdownify | remove: "<p>" | remove: "</p>" %}
{% else %}
{% assign title = post.title %}
Expand Down
5 changes: 5 additions & 0 deletions _layouts/doc.html
@@ -0,0 +1,5 @@
---
layout: single
---

{{ content }}

0 comments on commit 1946da7

Please sign in to comment.