Commit 40c091ca authored by Jacek Lebioda's avatar Jacek Lebioda
Browse files

Removed obsolete readmes #4

parent 74d61bc8
Pipeline #15860 passed with stage
in 1 minute and 18 seconds
# Gitlab pages
Welcome to an example page!
Below you will find a detailed instruction on how to set-up your own gitlab website.
For a better view, please go to the following website: [](
Sources for this page are [available in Gitlab](
Additionally, you can also navigate to the [repository for theme](
# Setting up your web page
## The process
0. Make sure that you have access to [gitlab]( If you ever cloned a repository or set-up a new one there, then you should be fine.
1. [Create an empty repository in gitlab]( Please bear in mind, that the both names of the namespace and the project influence
final address of the page - it will follow the `https://<namespace><project_name>` convention.
2. Clone this very repository: `git clone ssh://`.
3. Once cloned, remove the _remote_ (so that every time you push to your repository, you don't push to this very repository):
`cd project_name; git remote rm origin`, and add _remote_ to your new repository (you can find the correct remote address and the appropriate command in Gitlab, in your new repository page) **TODO: add screenshot**.
4. Modify site's settings (`_config.yml`) to match your needs. Refer to the next section for help.
5. Modify the index page. Modify (or delete) help and about pages. Add your own content.
6. Commit and push to the repository.
7. If you want to have your page publicly available, make a ticket to SIU.
8. Your page is published! Go to `https://<namespace>` in your favourite browser, or the URL you specified in the SIU ticket.
9. (optional) In gitlab, go to **Settings** (under left-hand menu) > **General** > **Advanced** (hit `Expand` button) > **Remove fork relationship** (red button), then follow the instructions from the pop-up.
## What should you change in settings file?
* `baseurl` - this is very important. Set it to the name of the project (i.e. repository name). Here it's `pages-jekyll-lcsb-template`
* `url` - this is equally important. Please set it to ``. For example - if your project is inside `core-services` namespace, it should be: `url: ""`. For `minerva`, it would be: `url: ""`.
* `title` field
* `e-mail` field
* `description` field
* `date` field
* `banner` field - if you want to have your own banner (the text next to _uni.lu_ logo), please send us an email (`lcsb-sysadmins (at)`).
## Testing the web page locally
You can test your website locally (on your machine).
* First, make sure that you have Ruby installed. If not - please [install it](
* Then, install _bundler_ - `gem install bundler`.
* Next, initialize the site: `bundle install`.
* Finally, run the site: `bundle exec jekyll serve`.
## Common problems
### *The website looks broken! There are no images, no colors etc.*
You probably didn't configure `baseurl` parameter in the settings. Please take a look on `_settings.yml` file.
### *The links in the menu are not working (they point to "404: Not found").*
You probably didn't add `permalink` attribute. Or the post has `published: false` or `draft: true` set. Please take a look on the post file.
### Other problems?
Please send us an email! (`lcsb-sysadmins (at)`)
\ No newline at end of file
![Build Status](
Example [Jekyll] website using GitLab Pages. View it live at
[Learn more about GitLab Pages]( or read the the [official GitLab Pages documentation](
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
**Table of Contents** *generated with [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)
- [Using Jekyll locally](#using-jekyll-locally)
- [GitLab User or Group Pages](#gitlab-user-or-group-pages)
- [Did you fork this project?](#did-you-fork-this-project)
- [Other examples](#other-examples)
- [Troubleshooting](#troubleshooting)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## 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 (⚙)** > **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
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
image: ruby:2.5
JEKYLL_ENV: production
- bundle install
- bundle exec jekyll build -d public
- public
- master
## Configuration
You have some variables that you need to override in the `_config.yaml` file.
## Using Jekyll locally
To work locally with this project, you'll have to follow the steps below:
1. Fork, clone or download this project
1. [Install][] Jekyll
1. Download dependencies: `bundle`
1. Build and preview: `bundle exec jekyll serve`
1. Add content
The above commands should be executed from the root directory of this project.
Read more at Jekyll's [documentation][].
## GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to ``, where `namespace` is
your `username` or `groupname`. This can be done by navigating to your
project's **Settings**.
Read more about [user/group Pages][userpages] and [project Pages][projpages].
## Did you fork this project?
If you forked this project for your own use, please go to your project's
**Settings** and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
## Other examples
* [jekyll-branched]( demonstrates how you can keep your GitLab Pages site in one branch and your project's source code in another.
* The [jekyll-themes]( group contains a collection of example projects you can fork (like this one) having different visual styles.
## Enabling and configuring pagination
The template includes `jekyll-paginate-v2` plugin by default, but it's turned off.
To use it, configure the pagination following instructions from the next paragraph, go to `` file and change `enabled: false` to `enabled: true`, and `published: false` to `published: true`. Later, create a directory called `_posts` in the project root directory and fill it with posts.
You may also need to disable showing ``, by setting `published: false` in its contents.
There are two sections in `_config.yml`, that refer to pagination: first, ` - jekyll-paginate-v2` line in plugins section, and then the configuration dictionary:
enabled: true # Note, that setting it to disabled does not disable it completely, as it has to be also set to false in `` file
title: ':title - page :num of :max' # Customize the text
per_page: 8 # How many posts should be displayed on one page
permalink: '/page/:num/' # The URL to the index of pagination
limit: 0
sort_field: 'date' # How the posts should be sorted. can also be: `title` or any page attribute
sort_reverse: true
trail: # How many pages should be shown in paginator.
before: 2 # Show 2 before the current one, e.g. `< 5 6 CURRENT ...`
after: 2 # Show 2 after the current one, e.g. `... CURRENT 6 7 >`
To disable it completely, set `enabled` to `false`, remove the aforementioned sections from the configuration, and `gem "jekyll-paginate-v2", "~> 1.7"` from `Gemfile` (from the project's root), and remove `` file from project's root directory.
Refer to its [documentation]( for more detailed instructions.
## Troubleshooting
1. CSS is missing! That means two things:
* Either that you have wrongly set up the CSS URL in your templates, or
* your static generator has a configuration option that needs to be explicitly
set in order to serve static assets under a relative URL.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment