metal3.io Website

Contributing contents

We more than welcome contributions in the form of blog posts, pages and/or labs, reach out if you happen to have an idea or find an issue with our contents! Here's our guidelines for contents.

Test your changes in a local container

Run a jekyll container

• On a SELinux enabled OS:

  cd metal3-io.github.io
  sudo docker run -d --name metal3io -p 4000:4000 -v $(pwd):/srv/jekyll:Z jekyll/jekyll jekyll serve --watch

  NOTE: Be sure to cd into the metal3-io.github.io directory before running the above command as the Z at the end of the volume (-v) will relabel its contents so it can be written from within the container, like running chcon -Rt svirt_sandbox_file_t -l s0:c1,c2 yourself.

• On an OS without SELinux:

  cd metal3-io.github.io
  sudo docker run -d --name metal3io -p 4000:4000 -v $(pwd):/srv/jekyll jekyll/jekyll jekyll serve --watch

View the site

Visit http://0.0.0.0:4000 in your local browser. The Metal3.io website is a Jekyll site, hosted with GitHub Pages.

All pages are located under /pages. Each section of the site is broken out into their respective folders - /blogs for the various Blog pages, /docs for the Documentation and /videos for the videos that are shared.

All site images are located under /assets/images. Please do not edit these images.

Images that relate to blog entries are located under /assets/images/BLOG_POST_TITLE. The BLOG_POST_TITLE should match the name of the markdown file that you added under /_posts.