Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 2.09 KB
Raw

Setting up a dev environment for contribution

These pages make use of the Jekyll static website generator, specifically version 3.8.6, which aligns to the GitHub Pages implementation in GitHub Enterprise 2.7.0. The Gemfile in this repository can be used with the bundle Ruby Gem to resolve dependencies for Jekyll, but first you need to have a suitable Ruby environment in place.

Windows

A working configuration for Windows hasn't been found yet. Attempts using RubyInstaller ave failed when it comes to building the native components of the RedCarpet Gem (which is a dependency of Octopress).

Any Windows 10 users may wish to try the Ubuntu subsystem for Windows 10.

Docker (on Linux)

If you don't already have Docker installed follow the platform appropriate Get Docker instructions from the Docker Home Page.

  • Run an interactive bash shell in a copy of the Ruby image mapping host port 4000 to container port 4000 (Jekyll default)

    sudo docker run -it -p 4000:4000 --name my_jekyll ruby /bin/bash

  • Generate an ssh key within the container and display the public key

    ssh-keygen -t rsa -f ~/.ssh/id_rsa -N '' && cat ~/.ssh/id_rsa.pub

  • Copy the public key and paste into GitHub > Settings > SSH Keys > New SSH Key

Contributing

  • The Katacoda content is in the separate Git repository Online DevOps Dojo.

  • Clone the repository

    git clone git@github.com:dxc-technology/about-devops-dojo.git

  • Change directory into the repo

cd about-devops-dojo

  • Install Jekyll and its dependencies

    bundle install

  • Run the site locally

    bundle exec jekyll serve --host 0.0.0.0

  • A version of the site will now be available on port 4000 of the dev environment

  • If using Docker it's possible to attach another shell to the environment for editing using:

    sudo docker exec -it my_jekyll /bin/bash