Skip to content
Permalink
Browse files

Incorporate new Kubeflow site design into the hugo theme (#38)

* Landing page, and single content page basic setup works

* Section Nav fixed, and Content listins on section pages

* Remove legal/privacy links from footer until ready
  • Loading branch information...
abhi-g authored and k8s-ci-robot committed Jun 13, 2018
1 parent e2779df commit 62b9fbba7a7ea8f423ac032fe41f30285f3a7d9c
Showing with 2,076 additions and 159 deletions.
  1. +13 −9 config.toml
  2. +4 −0 content/docs/_index.md
  3. +20 −0 content/docs/kubeflow.md
  4. +4 −0 content/docs/started/_index.md
  5. 0 content/docs/{ → started}/getting-started-gke.md
  6. 0 content/docs/{ → started}/getting-started-minikube.md
  7. +4 −16 content/docs/{ → started}/getting-started.md
  8. +0 −25 layouts/docs/single.html
  9. +0 −21 layouts/partials/toc.html
  10. +0 −42 static/css/custom.css
  11. +0 −46 static/js/master.js
  12. +20 −0 themes/kf/LICENSE.md
  13. +2 −0 themes/kf/archetypes/default.md
  14. +8 −0 themes/kf/archetypes/docs.md
  15. 0 static/.gitkeep → themes/kf/layouts/404.html
  16. +51 −0 themes/kf/layouts/_default/baseof.html
  17. +18 −0 themes/kf/layouts/_default/list.html
  18. 0 themes/kf/layouts/_default/single.html
  19. +21 −0 themes/kf/layouts/docs/list.html
  20. +26 −0 themes/kf/layouts/docs/single.html
  21. +81 −0 themes/kf/layouts/index.html
  22. +12 −0 themes/kf/layouts/partials/footer.html
  23. +22 −0 themes/kf/layouts/partials/header.html
  24. +9 −0 themes/kf/layouts/partials/mobilenav.html
  25. +7 −0 themes/kf/layouts/partials/page-summary.html
  26. +14 −0 themes/kf/layouts/partials/secnav.html
  27. +6 −0 themes/kf/layouts/partials/toc.html
  28. 0 themes/kf/static/css/custom.css
  29. +1,241 −0 themes/kf/static/css/styles.css
  30. +1 −0 themes/kf/static/images/bg-k.svg
  31. +1 −0 themes/kf/static/images/bg-w.svg
  32. BIN themes/kf/static/images/diagram-FPO-2.png
  33. BIN themes/kf/static/images/diagram-FPO.png
  34. +1 −0 themes/kf/static/images/icn-people.svg
  35. +1 −0 themes/kf/static/images/logo-jupyter.svg
  36. +1 −0 themes/kf/static/images/logo-tensorflow.svg
  37. +1 −0 themes/kf/static/images/logo.svg
  38. +466 −0 themes/kf/static/js/scripts.js
  39. +21 −0 themes/kf/theme.toml
@@ -1,8 +1,8 @@
baseURL = "/"
languageCode = "en-us"
title = "Kubeflow"
theme = "kube"
description = "Kube is a professional and a responsive Hugo theme for developers and designers that offers a documentation section mixed with a landing page and a blog"
theme = "kf"
description = "Kubeflow makes deployment of ML Workflows on Kubernetes straightforward and automated"
Paginate = 4
[Params]
RSSLink = "/index.xml"
@@ -12,14 +12,18 @@ Paginate = 4
email = "myemail@myaddress.xxx"

[[menu.main]]
name = "Docs"
weight = -100
name = "What is Kubeflow?"
weight = -103
url = "/docs/kubeflow/"
[[menu.main]]
name = "Getting Started"
weight = -102
url = "/docs/started/getting-started/"
[[menu.main]]
name = "Documentation"
weight = -101
url = "/docs/"
[[menu.main]]
name = "Blog"
name = "Additional Resources"
weight = -100
url = "/blog/"
[[menu.main]]
name = "FAQ/Help"
weight = -100
url = "/faq/"
@@ -0,0 +1,4 @@
+++
title = "Documentation"
description = "All of Kubeflow documentation"
+++
@@ -0,0 +1,20 @@
+++
title = "Kubeflow"
description = "Quickly get running with your ML Workflow"
weight = 10
bref = "The Kubeflow project is dedicated to making deployments of machine learning (ML) workflows on Kubernetes simple, portable and scalable. Our goal is not to recreate other services, but to provide a straightforward way to deploy best-of-breed open-source systems for ML to diverse infrastructures. Anywhere you are running Kubernetes, you should be able to run Kubeflow"

+++

## The Kubeflow Mission

Our goal is to make scaling machine learning (ML) models and deploying them to production as simple as possible, by letting Kubernetes do what it's great at:

* Easy, repeatable, portable deployments on a diverse infrastructure (laptop <-> ML rig <-> training cluster <-> production cluster)
* Deploying and managing loosely-coupled microservices
* Scaling based on demand

Because ML practitioners use a diverse set of tools, one of the key goals is to customize the stack based on user requirements (within reason) and let the system take care of the "boring stuff". While we have started with a narrow set of technologies, we are working with many different projects to include additional tooling.

Ultimately, we want to have a set of simple manifests that give you an easy to use ML stack _anywhere_ Kubernetes is already running, and can self configure based on the cluster it deploys into.

@@ -0,0 +1,4 @@
+++
title = "Getting Started"
description = "How to get started with Kubeflow on different platforms"
+++
File renamed without changes.
File renamed without changes.
@@ -1,25 +1,13 @@
+++
title = "Getting Started with Kubeflow"
description = "Quickly get running with your ML Workflow"
weight = 10
description = "Quickly get running with your ML Workflow on an existing Kubernetes installation"
weight = 25
draft = true
toc = true
bref = "The Kubeflow project is dedicated to making deployments of machine learning (ML) workflows on Kubernetes simple, portable and scalable. Our goal is not to recreate other services, but to provide a straightforward way to deploy best-of-breed open-source systems for ML to diverse infrastructures. Anywhere you are running Kubernetes, you should be able to run Kubeflow"

+++

## The Kubeflow Mission

Our goal is to make scaling machine learning (ML) models and deploying them to production as simple as possible, by letting Kubernetes do what it's great at:

* Easy, repeatable, portable deployments on a diverse infrastructure (laptop <-> ML rig <-> training cluster <-> production cluster)
* Deploying and managing loosely-coupled microservices
* Scaling based on demand

Because ML practitioners use a diverse set of tools, one of the key goals is to customize the stack based on user requirements (within reason) and let the system take care of the "boring stuff". While we have started with a narrow set of technologies, we are working with many different projects to include additional tooling.

Ultimately, we want to have a set of simple manifests that give you an easy to use ML stack _anywhere_ Kubernetes is already running, and can self configure based on the cluster it deploys into.

## Who should consider using Kubeflow?

Based on the current functionality you should consider using Kubeflow if:
@@ -38,8 +26,8 @@ functionality and actively soliciting help from companies and individuals intere

This documentation assumes you have a Kubernetes cluster already available.

* For local environment try [Minikube setup](/docs/getting-started-minikube/).
* For cloud environment try [GKE setup](/docs/getting-started-gke/).
* For local environment try [Minikube setup](/docs/started/getting-started-minikube/).
* For cloud environment try [GKE setup](/docs/started/getting-started-gke/).

For more general information on setting up a Kubernetes cluster please refer to [Kubernetes Setup](https://kubernetes.io/docs/setup/). If you want to use GPUs, be sure to follow the Kubernetes [instructions for enabling GPUs](https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus/).

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2018 kubeflow.org

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,2 @@
+++
+++
@@ -0,0 +1,8 @@
+++
title = "Title"
description = "Short description"
weight = 10
draft = truetoc = true
bref= ""
+++

File renamed without changes.
@@ -0,0 +1,51 @@
<!DOCTYPE html>
<html lang="{{ .Site.LanguageCode }}">
<head>
{{ .Hugo.Generator }}
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="author" content="Kubeflow">

<meta name="viewport" content="width=device-width, initial-scale=1">

<title>{{ block "title" . }}{{ .Title }} | {{ .Site.Title }}{{ end }}</title>

{{ with .Description }}
<meta name="description" content="{{ . }}"> {{ end }}

<link rel="home" href="/">

<!-- Google Material Icons -->
<link href="//fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<!-- FontAwsome 5 icons -->
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
<!-- Lato -->
<link href="//fonts.googleapis.com/css?family=Lato:400,400i,700,700i,900,900i" rel="stylesheet">
<!-- Roboto Mono -->
<link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,400i,700,700i" rel="stylesheet">

<!-- Stylesheets -->
<link rel="stylesheet" href="{{ "/css/styles.css" | relURL }}" type="text/css">
<link href="{{ "/css/custom.css" | relURL }}" rel="stylesheet" type="text/css">
<!--[if lt IE 9]>
<script src="http://css3-mediaqueries-js.googlecode.com/svn/trunk/css3-mediaqueries.js"></script>
<![endif]-->

</head>

<body>
<!-- mobile nav element -->
<div id="menu">
{{ block "mobilenav" . }}{{ end }}
</div>

<div id="wrapper">
<header>{{ block "header" . }}{{ end }}</header>
{{ block "main" . }}{{ end }}
<footer>{{ block "footer" . }}{{ end }}</footer>

<script src="//ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<script type="text/javascript" src="{{ "/js/scripts.js" | relURL }}">
</script>

</body>
</html>
@@ -0,0 +1,18 @@
{{ define "title"}} {{ .Title}} {{end}}
{{ define "header"}} {{ partial "header" .}} {{end}}

{{ define "main" }}

<div id="hero" class="wrap">
<h1>Voice of {{.Site.Params.author }} Developers</h1>
<p>Our vision, news and ideas, and whatever feels important.<br> <a href="https://twitter.com/{{.Site.Params.twitter}}">Follow us on Twitter</a></p>
</div>
<ul id="posts">

{{ range .Paginator.Pages.ByWeight }} {{ partial "page-summary" . }} {{ end }}
</ul>

{{ end }}
{{ define "footer" }}
{{ partial "footer" . }}
{{ end }}
No changes.
@@ -0,0 +1,21 @@
{{ define "title"}} {{ .Title}} {{end}}
{{ define "header"}} {{ partial "header" .}} {{end}}

{{ define "main" }}

<div id="hero" class="wrap">
<h1>{{ .Title }}</h1>
</div>
<section id="pageContent">
{{ range .Paginator.Pages.ByWeight }} {{ partial "page-summary" . }} {{ end }}

{{ range .Sections }}
{{ partial "page-summary" . }}
{{ end }}


</section>

{{ end }}
{{ define "footer" }} {{ partial "footer" . }} {{ end }}

@@ -0,0 +1,26 @@
{{ define "title" }} {{ .Title }} {{ end }}
{{ define "mobilenav" }} {{ partial "mobilenav" . }} {{ end }}
{{ define "header" }} {{ partial "header" . }} {{ end }}
{{ define "main" }}
<div id="subNav" class="">
{{ if .Params.toc }}
{{ partial "secnav" . }}
{{ partial "toc" . }}
{{ end }}
</div>

<section id="pageContent">
<div id="hero">
<h1 id="anchor1"> {{ .Title}} </h1>
<p class="hero-lead">
{{ .Params.bref | safeHTML }}.
</p>
</div>

{{ .Content }}

</section>
<!-- end pageContent -->

{{ end }}
{{ define "footer" }} {{ partial "footer" . }} {{ end }}

0 comments on commit 62b9fbb

Please sign in to comment.
You can’t perform that action at this time.