Tools for generating Kubernetes related manifests.
APACHE-2.0 License
The Upstream Community Theme is a ready-to-use Jekyll theme to help you create a basic static site for your project. It was designed with the Red Hat Upstream Community in mind, but can be used by anyone looking to create a simple, lightweight site.
These instructions will get you a copy of the project up and running on your local machine for development purposes. See deployment for notes on how to deploy the project on GitHub Pages.
ruby -v
to check your current Ruby version.gem -v
to check if you have RubyGems installed.gcc -v
,g++ -v
and make -v
to see if your system already has them installed.git clone [email protected]:YOUR_USER_NAME/dekorate.git
cd dekorate/docs
bundle exec jekyll serve
If you encounter any unexpected errors during the above, please refer to the troubleshooting page or the requirements page, as you might be missing development headers or other prerequisites.
For more information regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.
Alternatively, you can build the site and make it available on a local server using Docker without needing to install any tools in your local machine:
cd docs
docker run -p 4000:4000 -v $(pwd):/site bretfisher/jekyll-serve
The site will be up and running in localhost:4000
.
Or you can just use docker compose:
docker compose up
To deploy your site using GitHub Pages you will need to add the github-pages gem.
To use the github-pages gem, you'll need to add the following on your Gemfile
:
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
And then run bundle update
.
To deploy a project page that is kept in the same repository as the project they are for, please refer to the Project Pages section in Deploying Jekyll to GitHub Pages.
Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.
This project is licensed under the MIT License - see the LICENSE.txt file for details.
The side navigation bars make use of the /_data/sidebar.yml
file, here you can write down the title and url where you want to page to be reached at. It will automatically be added to the website.
Please make sure the url
here is the same as the permalink
inside the page front matter.
For example:
sidebar.yml
-
title: Getting Started
url: /docs/getting-started
docs/getting-started.md
-
title: Getting Started
description: Getting Started
layout: docs
permalink: /docs/getting-started
---
In order to create a navigation dropdown follow the following example:
url: /docs/usage
dropdown:
- title: Kubernetes
url: /docs/kubernetes
- title: Container Resources
url: /docs/container-resources
There are a few page layouts:
All documentation files should be added to the documentation/
folder and for the navigation to have /docs/page-name
in the url.
The website uses the jekyll-github-metadata plugin in order to display new releases automatically, this can be use for other purposes if need arises