From aaf95dff19d48977728e125a8e468a10f893be8d Mon Sep 17 00:00:00 2001
From: Jacek Lebioda <jaceklebi@o2.pl>
Date: Wed, 12 Dec 2018 11:42:40 +0100
Subject: [PATCH] Further updates of the readme etc.
---
README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++
index.md | 17 ++++++++---------
pagination.md | 5 +----
3 files changed, 62 insertions(+), 13 deletions(-)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8ca76b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# 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: [https://core-services.pages.uni.lu/pages-jekyll-lcsb-template/](https://core-services.pages.uni.lu/pages-jekyll-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).
+
+# 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.
+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 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>.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?
+Mandatory:
+ * `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 `https://gitlab-namespace-name.pages.uni.lu`. For example - if your project is inside `core-services` namespace, it should be: `url: "https://core-services.pages.uni.lu"`. For `minerva`, it would be: `url: "https://minerva.pages.uni.lu"`.
+
+Optional:
+ * `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`).
+
+## 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`.
+* 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) uni.lu`)
\ No newline at end of file
diff --git a/index.md b/index.md
index 4ce10ad..ec8616b 100644
--- a/index.md
+++ b/index.md
@@ -1,15 +1,11 @@
---
-# 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
title: Index
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 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).
@@ -22,7 +18,7 @@ Additionally, you can also navigate to the [repository for theme](https://git-r3
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**.
+`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.
@@ -32,13 +28,14 @@ Additionally, you can also navigate to the [repository for theme](https://git-r3
## What should you change in settings file?
Mandatory:
* `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 `https://gitlab-namespace-name.pages.uni.lu`. For example - if your project is inside `core-services` namespace, it should be: `url: "https://core-services.pages.uni.lu"`. For `minerva`, it would be: `url: "https://minerva.pages.uni.lu"`.
Optional:
* `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), send us an email.
+ * `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`).
## Testing the web page locally
You can test your website locally (on your machine).
@@ -49,10 +46,12 @@ You can test your website locally (on your machine).
* 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.
\ No newline at end of file
+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) uni.lu`)
\ No newline at end of file
diff --git a/pagination.md b/pagination.md
index 7c0bbf5..04914ed 100644
--- a/pagination.md
+++ b/pagination.md
@@ -4,11 +4,8 @@
# pagination:
# enabled: true
-# And inside index.md, add `published: false`
+# And inside `index.md` header (e.g. after `title: index`), add `published: false`
-# 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
title: index
layout: paginated_index
--
GitLab