Skip to content

Latest commit

 

History

History
115 lines (75 loc) · 4.56 KB

README.md

File metadata and controls

115 lines (75 loc) · 4.56 KB
Raw

containerd website

The containerd website can be accessed at https://containerd.io. This site includes the containerd documentation as well as general project information and more.

The containerd site is built using the Hugo static site generator and published using Netlify.

Running locally

In order to run the site locally, you'll need to install the version of Hugo specified using the HUGO_VERSION environment variable in netlify.toml. Instructions can be found in the official Hugo documentation.

Once you have the proper Hugo version installed, install this package and its dependencies with:

npm install .

Finally, run:

make serve

This will run Hugo in "watch" mode. You can open up your browser to http://localhost:1313 to see the rendered site. The site auto-refreshes when you modify files locally.

Publishing the site

The site is published automatically by Netlify. Whenever changes are merged to the main branch, Netlify will build and deploy the site to the https://containerd-io.netlify.com address (which is mapped to the containerd.io address via DNS). The site cannot be published manually.

Deploy previews

Whenever you submit a pull request to this repo, Netlify will automatically create a deploy preview with the requested changes. The URL for the deploy preview is:

https://deploy-preview-${PULL_REQUEST_NUMBER}--containerd-io.netlify.com/

The deploy preview URL for pull request number 100, for example, would be:

https://deploy-preview-100--containerd-io.netlify.com/

You can also access the deploy preview for a pull request by clicking Show all checks and then Details (next to the deploy/netlify check).

Contributing to the documentation

All of containerd's documentation is written in GitHub-flavored Markdown and contained in the content/docs folder.

Adding new docs

To create a new doc, add a Markdown file to content/docs. The name of the file will determine its URL. This doc, for example, would be available at https://containerd.io/docs/client-libraries:

touch content/docs/client-libraries.md

Once you've added the doc you'll need to add the following page metadata at the top, as YAML:

  • The title of the page
  • The weight of the page. This determines where in the documentation nav the doc appears. Docs with higher weight will be "lower" in the nav. Check the weight parameter of other docs to see where your new doc should fit in, and don't hesitate to modify the weight of other docs if the ordering needs to be changed.

Here's an example:

---
title: containerd client libraries
weight: 5
---

Technically Hugo also supports JSON and TOML for metadata, but please use YAML only for the sake of consistency.

Here are some optional parameters:

  • A description will show up underneath the doc's title at the top of the page. descriptions can be Markdown.
  • If you add draft: true to a page's metadata, it will be rendered when you run the site locally and in deploy preview but not on the production site at https://containerd.io. Drafts can be useful for stubbing out and collaborating on documentation content that you want to release at a later date.
  • The short parameter determines how the doc appears in the documentation navigation. If you add short: Clients to the example client libraries doc, it will show up as Clients in the nav.

Here's a YAML metadata example with optional parameters:

---
title: containerd client libraries
short: Clients
weight: 5
description: Use containerd in conjunction with a variety of programming languages
draft: true
---

Admonition blocks

There are five admonition blocks available for the containerd docs:

  • info (blue)
  • success (green)
  • warning (yellow)
  • danger (red)
  • requirement (purple)

To use an admonition block (in this case a success block):

Here is some normal documentation.

{{< success >}}
And here is a green "success" block
{{< /success >}}

You can use Markdown inside of admonition blocks.

Checking links

To check the site's internal links for 404s and other issues, run make check-links. This deletes the public directory, builds the production version of the site, and checks the output.