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

Guide, part 2

parent b3d11f11
...@@ -26,8 +26,9 @@ banner: default # When you have custom images, change this setting's value to t ...@@ -26,8 +26,9 @@ banner: default # When you have custom images, change this setting's value to t
logo: small # Change to "big" (without quotas) in case of having broad logo logo: small # Change to "big" (without quotas) in case of having broad logo
date: "2018" date: "2018"
#twitter_username: jekyllrb twitter_username: uni_lu
#github_username: jekyll facebook_username: uni.lu
linkedin_schoolname: university-of-luxembourg
# Build settings # Build settings
markdown: kramdown markdown: kramdown
......
...@@ -5,4 +5,4 @@ permalink: /the-help/ ...@@ -5,4 +5,4 @@ permalink: /the-help/
order: 3 order: 3
--- ---
This is the `help` page. If you need help, don't hesitate to send us an email.
\ No newline at end of file \ No newline at end of file
...@@ -23,18 +23,36 @@ Additionally, you can also navigate to the [repository for theme](https://git-r3 ...@@ -23,18 +23,36 @@ Additionally, you can also navigate to the [repository for theme](https://git-r3
2. Clone this very repository: `git clone ssh://git@git-r3lab-server.uni.lu:8022/core-services/pages-jekyll-lcsb-template.git`. 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): 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 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. 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. 5. Modify the index page. Modify (or delete) help and about pages. Add your own content.
6. Commit and push to the repository. 6. Commit and push to the repository.
7. If you want to have your page publicly available, make a ticket to SIU. 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. 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? ## What should you change in settings file?
**TODO** 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`
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.
## 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 ## Common problems
### *The website looks broken! There are no images, no colors etc.* ### *The website looks broken! There are no images, no colors etc.*
You probably didn't configure `baseurl` parameter in the settings. 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 pages).* ### *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. 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 \ 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