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

Merge branch 'develop' into 'master'

Develop

See merge request core-services/pages-jekyll-lcsb-template!5
parents 01b7ec71 cc17d27d
Pipeline #15931 passed with stages
in 1 minute and 32 seconds
......@@ -4,6 +4,7 @@ title: "Welcome to Jekyll!"
date: 2018-03-12 17:03:38 +0100
categories: jekyll update
---
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
......
......@@ -5,12 +5,16 @@ permalink: /about/
order: 2
---
This is the LCSB Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
Here you would normally put your contact information.
You can find the source code for this them at Gitlab:
~~~
You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
You can find the source code for this theme at Gitlab:
[core-services/jekyll-theme-lcsb-default](https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default).
We have successfully helped in publishing the following websites:
We have successfully helped in publishing at least (their number is increasing) the following websites:
* [Page of theme](https://core-services.pages.uni.lu/jekyll-theme-lcsb-default/)
* [This very page](https://core-services.pages.uni.lu/pages-jekyll-lcsb-template/)
* [Minerva doc's](https://minerva.pages.uni.lu/doc/)
......
......@@ -5,4 +5,4 @@ permalink: /the-help/
order: 3
---
If you need help, don't hesitate to send us an email.
\ No newline at end of file
If you need help, don't hesitate to send us (`lcsb-sysadmins (at) uni.lu`) an email!
\ No newline at end of file
......@@ -5,51 +5,67 @@ order: 1
---
# Gitlab pages
Welcome to an example page! Below you will find a detailed instruction on how to set-up your own gitlab website.
Welcome to an example page! Below you will find a detailed instruction on how to set-up your own Jekyll website with Gitlab-CI and our LCSB template.
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).
If you are interested, have found any issues with the layout or have a helpful suggestion, you can also navigate to the [repository for theme](https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default).
# Setting up your web page
## 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. If you don't have it, either contact the sysadmins (`lcsb-sysadmins (at) uni.lu`) or open a ticket at [https://service.uni.lu](https://service.uni.lu).
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.
## The whole process to deploy your website
0. Make sure that you have access to our [LCSB's Gitlab - https://git-r3lab.uni.lu/](https://git-r3lab.uni.lu/). If you ever cloned a repository or set-up a new one there, then you should be fine. If you don't have it, either contact the sysadmins (`lcsb-sysadmins (at) uni.lu`) or open a ticket at [https://service.uni.lu](https://service.uni.lu).
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 internally follow the `https://<namespace>.pages.uni.lu/<project_name>` convention. (Note, that in the very last step, SIU can set a new alias/URL for your website)
![image](assets/screenshots/new_project.png)
2. On your computer, clone this very repository using: `git clone ssh://git@git-r3lab-server.uni.lu:8022/core-services/pages-jekyll-lcsb-template.git`.
3. Once cloned, navigate into cloned repository (`cd pages-jekyll-lcsb-template`) and remove the _remote_ (so that you update your repository, and not this very page):
`git remote rm origin`, and add _remote_ to your repository. You can find the correct remote address in gitlab, as in the following image:
2. On your computer, clone this very repository using: ```git clone ssh://git@git-r3lab-server.uni.lu:8022/core-services/pages-jekyll-lcsb-template.git```.
3. Once cloned, navigate into cloned repository and remove the _remote_ (so that you update your repository, and not this very page):
```cd pages-jekyll-lcsb-template
git remote rm origin
```, and add _remote_ to your repository.
```
git remote add <HERE PASTE YOUR REMOTE URL, AS SHOWN BELOW>
# e.g. git remote add origin ssh://git@git-r3lab-server.uni.lu:8022/firstname.surname/your_projects_name.git
```
You can find the correct remote address in gitlab, as in the following image:
![image](assets/screenshots/remote.png)
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. Add your changes (`git add .`), commit (`git commit -m "Initial commit"`) and push (`git push --set-upstream master`) 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.
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.
7. 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.
8. 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.
9. If you want to have your page publicly available - contact us (`lcsb-sysadmins (at) uni.lu`), we will make a ticket to SIU.
## What should you change in settings file?
Nothing! :) We've taken care of everything for you!
We used to require a change in `url` and `baseurl` - but not anymore :)
However, you still might want to change:
You may want to change:
* `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) uni.lu`).
* `banner` field - if you want to have your own banner (the text next to _uni.lu_ logo), please contact us.
## 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](https://www.ruby-lang.org/en/downloads/).
* Then, install _bundler_ - `gem install bundler`.
* Next, initialize the site: `bundle install`.
* Then, from terminal install _bundler_ - `gem install bundler`.
* Navigate into a directory with your website
* Initialize the site with: `bundle install`.
* Finally, run the site: `bundle exec jekyll serve`.
## Please don't change/remove Gemfile and .gitlab-ci.yml files
They are mandatory in order for the website to work. First one contains the website dependencies, the second is responsible for building the website.
## Common problems
### *The website is not updated after commiting to the repository!*
Did you push the commit? If yes, then you probably changed/deleted `.gitlab-ci.yml` file.
### *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.
You probably didn't configure `baseurl` parameter in the settings or configured it wrongly. 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.
......
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