index.md 2.28 KB
Newer Older
Christophe Trefois's avatar
Christophe Trefois committed
1
2
3
4
5
---
# You don't need to edit this file, it's empty on purpose.
# Edit theme's home layout instead if you wanna make some changes
# See: https://jekyllrb.com/docs/themes/#overriding-theme-defaults
layout: default
Jacek Lebioda's avatar
Jacek Lebioda committed
6
7
title: Index
order: 1
Christophe Trefois's avatar
Christophe Trefois committed
8
---
Yohan Jarosz's avatar
Yohan Jarosz committed
9

Jacek Lebioda's avatar
Jacek Lebioda committed
10
11
12
# Gitlab pages
Welcome to an example page! 
Below you will find a detailed instruction on how to set-up your own gitlab website.
Yohan Jarosz's avatar
Yohan Jarosz committed
13

Jacek Lebioda's avatar
Jacek Lebioda committed
14
15
Sources for this page are [available in Gitlab](https://git-r3lab.uni.lu/core-services/pages-jekyll-lcsb-template).
Additionally, you can also navigate to the [repository for theme](https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default).
Yohan Jarosz's avatar
Yohan Jarosz committed
16

Jacek Lebioda's avatar
Jacek Lebioda committed
17
# Setting up your web page
Christophe Trefois's avatar
Christophe Trefois committed
18

Jacek Lebioda's avatar
Jacek Lebioda committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
## The process
0. Make sure that you have access to [gitlab](https://git-r3lab.uni.lu/). 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](https://git-r3lab.uni.lu/projects/new). 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>.pages.uni.lu/<project_name>` convention.
2. Clone this very repository: `git clone ssh://git@git-r3lab-server.uni.lu:8022/core-services/pages-jekyll-lcsb-template.git`.
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 repository (you can find the correct remote address in gitlab) **TODO: add screenshot**.
4. Modify site's settings 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>.pages.uni.lu/name-of-repository` in your favourite browser, or the URL you specified in the SIU ticket.

## What should you change in settings file?
**TODO**

## Common problems
### *The website looks broken! There are no images, no colors etc.*
You probably didn't configure `baseurl` parameter in the settings.

### *The links in the menu are not working (they point to 404 pages).*
You probably didn't add `permalink` attribute. Or the post has `published: false` or `draft: true` set.