Commit b3d11f11 authored by Jacek Lebioda's avatar Jacek Lebioda
Browse files

Guide, part 1

parent 93b90382
......@@ -7,9 +7,34 @@ title: Index
order: 1
---
This is the `default lcsb theme` for gitlab pages...
# Gitlab pages
Welcome to an example page!
Below you will find a detailed instruction on how to set-up your own gitlab website.
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).
You can follow the [documentation](https://git-r3lab.uni.lu/core-services/pages-jekyll-lcsb-template/blob/master/README.md) to understand how to use it.
# Setting up your web page
Mz website is better than yours.
\ No newline at end of file
## 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.
\ No newline at end of file
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