Skip to content
This repository has been archived by the owner on Feb 25, 2020. It is now read-only.

cloudbees/cs-onboarding

Repository files navigation

Getting started:

a) Hugo using Homebrew:

  1. Install Hugo 0.62.0 to test locally:

https://raw.githubusercontent.com/Homebrew/homebrew-core/3248755996969c509fcdeb801f4b0c5ca459fa1a/Formula/hugo.rb

Here are the official docs to install Hugo using Homebrew but unfortunately Homebrew only keeps the latest version of Hugo which can bring incompatibility issues.

  1. Make sure you have version 0.62.0 installed by running hugo version.

  2. Clone this repo:

git clone https://github.com/cloudbees/cs-onboarding.git --recurse-submodules

  1. Once you cloned this repo and installed Hugo in your machine. Go inside the csa-onboarding directory and execute hugo -D server.

  2. Go to localhost:1313 in your favorite browser and you should see the website.

b) Hugo with Docker 🐳:

  1. Get Docker in case you don't have it: https://docs.docker.com/docker-for-mac/install/ or run brew cask install docker

  2. Clone this repo:

git clone https://github.com/cloudbees/cs-onboarding.git --recurse-submodules

  1. Run the following command inside the csa-onboarding directory:
docker run --rm -it \
 -v $(pwd):/src \
  -p 1313:1313 \
  klakegg/hugo:0.62.0 \
  server 
  1. Go to localhost:1313 in your favorite browser and you should see the website.

Want to know more about Hugo and its themes?

How to contribute:

  1. Follow the "Getting Started" directions to see how these pages get created in your local environment.
    Take a look at cs-onboarding/content/support or cs-onboarding/content/cloudbees-core directories. The articles (.md files) inside the directories follow the structure in the website. The main configuration file for the page is in cs-onboarding/config.toml .

  2. Create a branch with a name of your preference.

  3. Once you are in your new branch, create a new folder under content for your new section and a or multiple new .md file(s) under such folder. You can also just add a new .md file under an existing folder if you don't want to create a new section. Finally you can also try using hugo new. Once you have added your files and/or new folders, make sure there are no issues in your local environment.

  4. Open a PR when done against the master branch.

  5. This is what happens next: https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md#the-code-review-process

*** (more CI/CD stuff to come so you can see that it not only works in your machine) ***