This repo contains the sources for the OKD.io.
Note Node.js
is a required dependency on Linux machines
Firstly install the necessary packages on your machine:
sudo apt-get install ruby-full
sudo gem install bundler
sudo bundle install
To develop on your local machine run the middleman server and you should be able to preview your changes at http://localhost:4567
bundle exec middleman server
To test a local version of the site using a containerized builder/server, please see the local containerized server instructions.
Create a file in the directory source/blog.
The filename must be in the format: yyyy-mm-dd-<title>.html.markdown
The first lines of the file must contain this:
---
title: <TITLE>
date: yyyy-mm-dd (exactly the same date as for the filename!)
tags: upgrade (choose tags to categorize articles)
---
< MARKDOWN :-) >
Create a Markdown file in the directory source/guides.
The filename must be in the format: yyyy-mm-dd-<title>.html.markdown.
It is recommended that you reference the platform and deployment method in
your title, for example 2021-12-31-vSphere-UPI-Disconnected-Network.html.markdown
.
The first lines of the file must contain this frontmatter data:
---
title: <TITLE>
authors:
- "@<Github handle>"
last-updated: "yyyy-mm-dd"
okd-version: "X.Y.Z"
---
< MARKDOWN :-) >
To deploy your changes please submit a pull request while following our contribution guidelines
Make sure to populate the OPENSHIFT_GITHUB_ID
and OPENSHIFT_GITHUB_SECRET
env variables to ensure authenticated GitHub API usage (and prevent request throttling).