From 0a9c9347c2798d9a4223156b8b73758c207c1d77 Mon Sep 17 00:00:00 2001 From: Adam Voss Date: Wed, 8 Mar 2017 23:59:51 -0600 Subject: [PATCH] Getting Started instructions added to README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 5f9b2a4..83f58e9 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,9 @@ documentation https://docs.gitlab.com/ce/user/project/pages/. **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* +- [Getting Started](#getting-started) + - [Start by forking this repository](#start-by-forking-this-repository) + - [Start from a local Jekyll project](#start-from-a-local-jekyll-project) - [GitLab CI](#gitlab-ci) - [Building locally](#building-locally) - [GitLab User or Group Pages](#gitlab-user-or-group-pages) @@ -22,6 +25,29 @@ documentation https://docs.gitlab.com/ce/user/project/pages/. +## Getting Started + +You can get started with GitLab Pages using Jekyll easily by either forking this repository or by uploading a new/existing Jekyll project. + +Remember you need to wait for your site to build before you will be able to see your changes. You can track the build on the **Pipelines** tab. + +### Start by forking this repository + +1. Fork this repository. +1. **IMPORTANT:** Remove the fork relationship. +Go to **Settings (⚙)** > **Edit Project** and click the **"Remove fork relationship"** button. +1. Enable Shared Runners. +Go to **Settings (⚙)** > **CI/CD Pipelines** and click the **"Enable shared Runners"** button. +1. Rename the repository to match the name you want for your site. +1. Edit your website through GitLab or clone the repository and push your changes. + +### Start from a local Jekyll project + +1. [Install][] Jekyll. +1. Use `jekyll new` to create a new Jekyll Project. +1. Add [this `.gitlab-ci.yml`](.gitlab-ci.yml) to the root of your project. +1. Push your repository and changes to GitLab. + ## GitLab CI This project's static Pages are built by [GitLab CI][ci], following the steps