Migrate website to Hugo

Signed-off-by: Luc Perkins <lucperkins@gmail.com>
This commit is contained in:
Luc Perkins 2018-05-14 12:18:32 -07:00
parent b511c397c3
commit d1503dc9ce
67 changed files with 236 additions and 241 deletions

View File

@ -1 +0,0 @@
2.4.2

View File

@ -1,4 +0,0 @@
source "https://rubygems.org"
gem "jekyll"
gem "jekyll-redirect-from"
gem "jekyll-seo-tag"

View File

@ -1,69 +0,0 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
colorator (1.1.0)
concurrent-ruby (1.0.5)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.5)
ffi (1.9.18)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (0.9.1)
concurrent-ruby (~> 1.0)
jekyll (3.7.0)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (~> 1.14)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-redirect-from (0.13.0)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.1)
sass (~> 3.4)
jekyll-seo-tag (2.4.0)
jekyll (~> 3.3)
jekyll-watch (2.0.0)
listen (~> 3.0)
kramdown (1.16.2)
liquid (4.0.0)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
pathutil (0.16.1)
forwardable-extended (~> 2.6)
public_suffix (3.0.1)
rb-fsevent (0.10.2)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (3.1.0)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.5.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
PLATFORMS
ruby
DEPENDENCIES
jekyll
jekyll-redirect-from
jekyll-seo-tag
BUNDLED WITH
1.16.1

13
docs/.editorconfig Normal file
View File

@ -0,0 +1,13 @@
[*]
end_of_line = lf
charset = utf-8
max_line_length = 80
trim_trailing_whitespace = true
insert_final_newline = false
[*.{html,js,sh,sass,md,mmark}]
indent_style = space
indent_size = 2
[Makefile]
indent_style = tab

8
docs/.gitignore vendored
View File

@ -1,8 +1,6 @@
**/.DS_Store
**/desktop.ini
.bundle/**
.jekyll-metadata
_site/**
.sass-cache/**
CNAME
Gemfile.lock
# Hugo-generated content
public/

View File

@ -15,4 +15,4 @@
FROM nginx
COPY _site /usr/share/nginx/html
COPY public /usr/share/nginx/html

25
docs/hooks/pre_build → docs/Makefile Executable file → Normal file
View File

@ -1,5 +1,3 @@
#!/bin/bash
# Copyright The containerd Authors.
# Licensed under the Apache License, Version 2.0 (the "License");
@ -14,13 +12,20 @@
# See the License for the specific language governing permissions and
# limitations under the License.
HUGO = hugo
BASE_URL = https://containerd.io
echo "=> Building the binary"
docker run --privileged \
-v $(pwd):/usr/src/app \
-v /var/run/docker.sock:/var/run/docker.sock \
starefossen/github-pages jekyll build
echo $(pwd)
ls -la
ls -la _site
clean:
rm -rf public
build: clean
$(HUGO) \
--baseURL $(BASE_URL)
build-preview: clean
$(HUGO)
dev: clean
$(HUGO) server \
--disableFastRender \
--ignoreCache

View File

@ -1,10 +1,12 @@
# Containerd website
The containerd website is built using Jekyll and published to Github pages.
The containerd website at https://containerd.io is built using [Hugo](https://gohugo.io) and published to [Netlify](https://netlify.com).
In order to build and test locally:
```
docker run -it -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages
```
Then browser to localhost:4000 to see the rendered site. The site autorefreshes when you modify files locally.
To develop the site locally in "watch" mode (using Docker):
```bash
$ docker run -it -v $(pwd):/src -p "1313:1313" -e HUGO_WATCH=true jojomi/hugo
```
You can then open up your browser to localhost:1313 to see the rendered site. The site auto-refreshes when you modify files locally.

View File

@ -1,23 +0,0 @@
markdown: kramdown
kramdown:
input: GFM
html_to_native: true
hard_wrap: false
syntax_highlighter: rouge
incremental: true
permalink: pretty
safe: false
lsi: false
exclude: [README.md]
plugins:
- jekyll-redirect-from
- jekyll-seo-tag
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: default

View File

@ -1,21 +0,0 @@
<div class="footer">
<div class="footer-links">
{% include links.html %}
</div>
<div class="copyright">
Copyright (c) 2016-2018 the containerd authors
</div>
</div>
<script src="style/js/jquery-2.1.4.min.js"></script>
<script src="style/js/highlight.min.js"></script>
<script src="style/js/main.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-71407002-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>

View File

@ -1,14 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{{ page.title }}</title>
<link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16">
<link href="style/css/flexboxgrid.css" type="text/css" rel="stylesheet" media="screen,projection"/>
<link href="style/css/main.css" type="text/css" rel="stylesheet" media="screen,projection"/>
<link href="style/css/tomorrow-night.css" type="text/css" rel="stylesheet" media="screen,projection"/>
<link href="https://fonts.googleapis.com/css?family=Lato:300,400|Raleway:400,700i,800" rel="stylesheet">
</head>
<body>
<div class="container">

View File

@ -1,3 +0,0 @@
<div class="link">
<a href="https://github.com/containerd/containerd"><img src="images/containerd-light-d.png"/></a>
</div>

View File

@ -1,15 +0,0 @@
{% include header.html %}
<div class="navbar white">
<div class="name"><a href="/">containerd<span class="org">By Docker</span></a></div>
<div class="actions">
{% include links.html %}
</div>
</div>
<div class="content">
<div class="wrapper-details">
{{ content }}
</div>
</div>
{% include footer.html %}

View File

@ -1,18 +0,0 @@
{% include header.html %}
<div class="hero">
<div class="navbar">
<div class="name"><a href="/">containerd</a></div>
<div class="actions">
{% include links.html %}
</div>
</div>
<p class="definition"><strong>containerd</strong> <span>| kənˈtānər D |</span><br> - an industry-standard container runtime<br>with an emphasis on <i>simplicity</i>,<br><i>robustness</i> and <i>portability</i>.</p>
</div>
<div class="content">
<div class="wrapper-details">
{{ content }}
</div>
</div>
{% include footer.html %}

16
docs/config.yaml Normal file
View File

@ -0,0 +1,16 @@
title: containerd
baseURL: /
disableKinds: ["taxonomy", "taxonomyTerm"]
params:
googleAnalyticsId: UA-71407002-1
favicon: /img/favicon.png
fontImport: https://fonts.googleapis.com/css?family=Lato:300,400|Raleway:400,700i,800
css:
- main
- flexboxgrid
- tomorrow-night
js:
- jquery-2.1.4.min
- highlight.min
- main

View File

@ -1,17 +1,9 @@
---
title: containerd
layout: home
---
## News
* [Sign up for DockerCon in June](https://2018.dockercon.com)
* [Feb 2018: containerd 1.0.2-rc.1 release](https://github.com/containerd/containerd/releases/tag/v1.0.2-rc.1)
* [Dec 2017: The New Stack: Containerd 1.0 Release Becomes the Public Face of Containers](https://thenewstack.io/containerd-1-0-release/)
* [Dec 2017: containerd 1.0 release announcement](https://blog.docker.com/2017/12/cncf-containerd-1-0-ga-announcement/)
* [March 2017: Docker to donate containerd to the Cloud Native Computing Foundation](https://blog.docker.com/2017/03/docker-donates-containerd-to-cncf/)
* [February 2017: containerd Summit recap](https://blog.docker.com/2017/02/containerd-summit-recap-slides-videos-meeting-notes/)
* [January 2017: containerd Livestream recap](https://blog.docker.com/2017/01/containerd-livestream-recap)
{{< news >}}
## About containerd
@ -23,18 +15,11 @@ containerd includes a daemon exposing gRPC API over a local UNIX socket. The API
containerd is based on the Docker Engines core container runtime to benefit from its maturity and existing contributors.
![Containerd High Level Architecture](images/chart-a.png "Containerd High Level Architecture")
![Containerd High Level Architecture](/img/chart-a.png "Containerd High Level Architecture")
## Features and roadmap
* OCI Image Spec support
* OCI Runtime Spec support (aka runC)
* Image push and pull support
* Container runtime and lifecycle support
* Network primitives for creation, modification, and deletion of interfaces
* Management of network namespaces containers to join existing namespaces
* Multi-tenant supported with CAS storage for global images
{{< features >}}
containerd, currently in [version 1.0.1](https://github.com/containerd/containerd/releases/tag/v1.0.1), is a daemon born from extracting the container execution subset of the Docker Engine, and is [used internally by Docker since the 1.11 release](https://blog.docker.com/2016/04/docker-engine-1-11-runc/). containerd versions prior to v1.0.x were used in Docker 17.10 and earlier (see Docker [version release notes](https://github.com/docker/docker-ce/releases)), and [Docker 17.12](https://github.com/docker/docker-ce/releases/tag/v17.12.0-ce) is the first release to use containerd v1.0.0.
@ -42,9 +27,9 @@ The containerd maintainers do not provide a consolidated [containerd roadmap](ht
## Architecture
Containerd [architecture](https://github.com/containerd/containerd/blob/master/design/architecture.md) and [API](https://github.com/containerd/containerd/tree/master/api/) are described in the Github repository.
Containerd [architecture](https://github.com/containerd/containerd/blob/master/design/architecture.md) and [API](https://github.com/containerd/containerd/tree/master/api/) are described in the GitHub repository.
![Containerd Architecture](images/chart-b.png "Containerd High Level Architecture")
![Containerd Architecture](/img/chart-b.png "Containerd High Level Architecture")
## Principles and Releases
@ -93,27 +78,27 @@ Each major version will be supported for 1 year with bug fixes and security patc
Docker is a complete platform and programming environment for containerized applications. containerd is one of dozens of specialized components integrated into Docker. Developers and IT professionals looking to build, ship and run containerized applications should continue to use Docker. Operators and integrators looking for specialized components to swap into their platform should consider containerd.
![Containerd and Docker](images/chart-c.png "Containerd and Docker")
![Containerd and Docker](/img/chart-c.png "Containerd and Docker")
containerd 0.2.4 used in Docker 1.12 covers only container execution and process management.
![Containerd in Docker today](images/chart-g.png "Containerd in Docker today")
![Containerd in Docker today](/img/chart-g.png "Containerd in Docker today")
containerd's roadmap is to refactor the Docker Engine codebase to extract more of its logic for distribution, networking and storage on a single host into a reusable component that Docker will use, and that can be used by other container orchestration projects or hosted container services.
![Containerd in Docker tomorrow](images/chart-d.png "Containerd in Docker tomorrow")
![Containerd in Docker tomorrow](/img/chart-d.png "Containerd in Docker tomorrow")
2. What is the relationship between containerd, OCI and runc?
Docker [donated the OCI specification to the Linux Foundation in 2015](https://blog.docker.com/2015/06/open-container-project-foundation/), along with a reference implementation called `runc`. containerd integrates [OCI](https://www.opencontainers.org/)/[runc](https://runc.io/) into a feature-complete, production-ready core container runtime. runc is a component of containerd, the executor for containers. containerd has a wider scope than just executing containers: downloading container images, managing storage and network interfaces, calling runc with the right parameters to run containers. containerd fully leverages the Open Container Initiatives (OCI) runtime, image format specifications and OCI reference implementation (runc) and will pursue OCI certification when it is available. Because of its massive adoption, containerd is the industry standard for implementing OCI.
![Containerd, runc and OCI](images/chart-a.png "Containerd, runc and OCI")
![Containerd, runc and OCI](/img/chart-a.png "Containerd, runc and OCI")
3. What is the relationship between containerd and container orchestration systems like Kubernetes and Mesos?
Kubernetes today uses Docker directly. In a future version Kubernetes can implement container support in the Kubelet by implementing it's [Container Runtime Interface](https://github.com/kubernetes/kubernetes/blob/release-1.5/docs/devel/container-runtime-interface.md) using containerd. Mesos and other orchestration engines can leverage containerd for core container runtime functionality as well.
![Containerd in the container ecosystem](images/chart-f.png "Containerd in the container ecosystem")
![Containerd in the container ecosystem](/img/chart-f.png "Containerd in the container ecosystem")
4. What is the relationship between containerd and cloud managed container services?
@ -121,6 +106,6 @@ See answer above: cloud managed container services can leverage containerd inste
## CNCF
![Containerd is a Cloud Native Computing Foundation member project](images/CNCF_Alternate_Pantone.png "Containerd is a Cloud Native Computing Foundation member project")
![Containerd is a Cloud Native Computing Foundation member project](/img/CNCF_Alternate_Pantone.png "Containerd is a Cloud Native Computing Foundation member project")
We are a Cloud Native Computing Foundation member project.

View File

@ -1,4 +1,7 @@
# Client Options
---
title: Client options
draft: true
---
The containerd client was built to be easily extended by consumers.
The goal is that the execution flow of the calls remain the same across implementations while `Opts` are written to extend functionality.

View File

@ -1,6 +1,6 @@
---
title: Dockercon 2017 Summit
layout: home
draft: true
---
# Dockercon 2017 Summit

View File

@ -1,4 +1,7 @@
# Getting started with containerd
---
title: Getting started with containerd
draft: true
---
There are many different ways to use containerd.
If you are a developer working on containerd you can use the `ctr` tool to quickly test features and functionality without writing extra code.

View File

@ -1,4 +1,7 @@
# containerd Namespaces and Multi-Tenancy
---
title: containerd Namespaces and Multi-Tenancy
draft: true
---
containerd offers a fully namespaced API so multiple consumers can all use a single containerd instance without conflicting with one another.
Namespaces allow multi-tenancy within a single daemon. This removes the need for the common pattern of using nested containers to achieve this separation.

View File

@ -1,4 +1,7 @@
# containerd for Ops and Admins
---
title: containerd for Ops and Admins
draft: true
---
containerd is meant to be a simple daemon to run on any system.
It provides a minimal config with knobs to configure the daemon and what plugins are used when necessary.

7
docs/data/features.yaml Normal file
View File

@ -0,0 +1,7 @@
- OCI Image Spec support
- OCI Runtime Spec support (aka runC)
- Image push and pull support
- Container runtime and lifecycle support
- Network primitives for creation, modification, and deletion of interfaces
- Management of network namespaces containers to join existing namespaces
- Multi-tenant supported with CAS storage for global images

20
docs/data/news.yaml Normal file
View File

@ -0,0 +1,20 @@
- title: Sign up for DockerCon in June
link: https://2018.dockercon.com/
- title: containerd 1.0.2-rc.1 release
link: https://github.com/containerd/containerd/releases/tag/v1.0.2-rc.1
date: February 2018
- title: "The New Stack: Containerd 1.0 Release Becomes the Public Face of Containers"
link: https://thenewstack.io/containerd-1-0-release/
date: December 2017
- title: containerd 1.0 release announcement
link: https://blog.docker.com/2017/12/cncf-containerd-1-0-ga-announcement/
date: December 2017
- title: Docker to donate containerd to the Cloud Native Computing Foundation
link: https://blog.docker.com/2017/03/docker-donates-containerd-to-cncf/
date: March 2017
- title: containerd Summit recap
link: https://blog.docker.com/2017/02/containerd-summit-recap-slides-videos-meeting-notes/
date: February 2017
- title: containerd Livestream recap
link: https://blog.docker.com/2017/01/containerd-livestream-recap
date: January 2017

5
docs/layouts/404.html Normal file
View File

@ -0,0 +1,5 @@
{{ define "main" }}
<h2>
We're sorry, but this page could not be found. Return to the main site <a href="/">here</a>.
</h2>
{{ end }}

View File

@ -0,0 +1,35 @@
{{- $prodSite := not .Site.IsServer -}}
{{- $faviconUrl := .Site.Params.favicon | absURL -}}
{{- $fontImport := .Site.Params.fontImport -}}
<!DOCTYPE html>
<html lang="{{ default "en" .Site.LanguageCode }}">
<head>
{{ .Hugo.Generator }}
{{- partial "meta.html" . }}
<title>{{ block "title" . }}{{ .Site.Title }}{{ end }}</title>
{{- partial "css.html" . }}
<link rel="icon" type="image/png" href="{{ $faviconUrl }}" sizes="16x16">
<link href="{{ $fontImport }}" rel="stylesheet">
</head>
<body>
<div class="container">
<div class="hero">
{{- partial "navbar.html" . }}
{{- partial "definition.html" . }}
</div>
<div class="content">
<div class="wrapper-details">
{{ block "main" . }}
{{ end }}
</div>
</div>
</div>
{{- partial "footer.html" . }}
{{- partial "javascript.html" . }}
{{- if $prodSite }}
{{- partial "google-analytics.html" . }}
{{- end }}
</body>
</html>

View File

@ -0,0 +1,3 @@
{{ define "main" }}
{{ .Content }}
{{ end }}

View File

@ -0,0 +1,3 @@
{{ define "main" }}
<h1>This is a docs page</h1>
{{ end }}

3
docs/layouts/index.html Normal file
View File

@ -0,0 +1,3 @@
{{ define "main" }}
{{ .Content }}
{{ end }}

View File

@ -0,0 +1,4 @@
{{- $cssFiles := .Site.Params.css -}}
{{- range $cssFiles }}
<link rel="stylesheet" href="{{ printf "/css/%s.css" . | absURL}}">
{{- end }}

View File

@ -0,0 +1,3 @@
<p class="definition">
<strong>containerd</strong> <span>| kənˈtānər D |</span><br> &ndash; an industry-standard container runtime<br>with an emphasis on <i>simplicity</i>,<br><i>robustness</i> and <i>portability</i>.
</p>

View File

@ -0,0 +1,10 @@
<div class="footer">
<div class="footer-links">
<div class="link">
<a href="https://github.com/containerd/containerd"><img src="/img/containerd-light-d.png"/></a>
</div>
</div>
<div class="copyright">
Copyright (c) 2016-2018 the containerd authors
</div>
</div>

View File

@ -0,0 +1,9 @@
{{- $gaId := .Site.Params.googleAnalyticsId }}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', {{ $gaId }}, 'auto');
ga('send', 'pageview');
</script>

View File

@ -0,0 +1,4 @@
{{- $jsFiles := .Site.Params.js -}}
{{- range $jsFiles }}
<script src="{{ printf "/js/%s.js" . | absURL }}"></script>
{{- end }}

View File

@ -0,0 +1,2 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">

View File

@ -0,0 +1,8 @@
<div class="navbar">
<div class="name"><a href="/">containerd</a></div>
<div class="actions">
<div class="link">
<a href="https://github.com/containerd/containerd"><img src="/img/containerd-light-d.png"/></a>
</div>
</div>
</div>

View File

@ -0,0 +1,6 @@
{{- $features := .Site.Data.features }}
<ul>
{{- range $features }}
<li>{{ . | markdownify }}</li>
{{- end }}
</ul>

View File

@ -0,0 +1,10 @@
{{- $news := .Site.Data.news }}
<ul>
{{- range $news }}
<li>
<a href="{{ .link }}">
{{ with .date }}{{ . }}: {{ end }}{{ .title }}
</a>
</li>
{{- end }}
</ul>

View File

@ -105,7 +105,7 @@ section {
display: block;
}
body {
background: url(../../images/bg10.jpg);
background: url(../../img/bg10.jpg);
background-position: center;
background-attachment: fixed;
-webkit-background-size: cover;

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 2.3 KiB

After

Width:  |  Height:  |  Size: 2.3 KiB

View File

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

View File

Before

Width:  |  Height:  |  Size: 239 KiB

After

Width:  |  Height:  |  Size: 239 KiB

View File

Before

Width:  |  Height:  |  Size: 153 KiB

After

Width:  |  Height:  |  Size: 153 KiB

View File

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

View File

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View File

Before

Width:  |  Height:  |  Size: 123 KiB

After

Width:  |  Height:  |  Size: 123 KiB

View File

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 96 KiB

View File

Before

Width:  |  Height:  |  Size: 279 B

After

Width:  |  Height:  |  Size: 279 B

View File

Before

Width:  |  Height:  |  Size: 711 B

After

Width:  |  Height:  |  Size: 711 B

View File

Before

Width:  |  Height:  |  Size: 698 B

After

Width:  |  Height:  |  Size: 698 B

View File

Before

Width:  |  Height:  |  Size: 1.7 KiB

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

Before

Width:  |  Height:  |  Size: 273 B

After

Width:  |  Height:  |  Size: 273 B

View File

Before

Width:  |  Height:  |  Size: 713 B

After

Width:  |  Height:  |  Size: 713 B

View File

Before

Width:  |  Height:  |  Size: 400 B

After

Width:  |  Height:  |  Size: 400 B

View File

Before

Width:  |  Height:  |  Size: 1.7 KiB

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

View File

Before

Width:  |  Height:  |  Size: 231 B

After

Width:  |  Height:  |  Size: 231 B