Commit b32138f0 authored by WolfgangSchweer's avatar WolfgangSchweer

Update instructions and configuration for updating/creating blends websites.

Use sandbox instead of deleting the www/ folder in case jekyll is used.
It's one step more if the build framework is used to generate a new website,
but prevents accidentally deleting existing ones in this case.
parent 502533b4
Updating the blends websites
============================
Updating/adding blends websites
===============================
The www/ folder is removed and rebuilt when changes are made. Please make your
changes in the www-src/ folder instead.
Updating a blend
----------------
In order to build you changes you will need to install the jekyll package:
The www/ folder contains the static websites as they show up on the Debian
mirrors. Apply your changes there, commit and push.
Adding a new blend
------------------
You could just create it in the www/ folder.
If instead you want to use the build framework, you have to make your changes
the www-src/ folder.
Each blend sub-site has a layout in the www-src/_layouts directory. You can copy
the template.html file there to <blend-name>.html. Each blend also has an
independent navigation menu in www-src/_includes. You can copy the template_menu.html
file to <blend-name>_menu.html. Inside the www-src/template directory you can see
an example home page you can use.
In order to build your changes you will need to install the jekyll package:
apt-get install jekyll
After you have made your changes, in the www-src folder run:
After you have made your changes, cd into the www-src/ folder and run:
jekyll build
This will update the latest version of the static website in the www folder
ready to be pushed to the Debian static mirrors.
Adding a new blend
------------------
This will create the a folder containing the new static blend website in the
www-sandbox/ folder; you can use a browser to check the site, also images
added to the img/folder/ will show up correctly in this case.
Each blend sub-site has a layout in the _layouts directory. You can copy the
template.html file there to <blend-name>.html. Each blend also has an
independent navigation menu in _includes. You can copy the template_menu.html
file to <blend-name>_menu.html. Inside the template directory you can see
an example home page you can use.
Please note: the www-sandbox/ folder is deleted each time you run 'jekyll build'
inside the www-src/ folder.
Copy your new site folder from the www-sandbox/ folder to the www/ one,
remove the www-sandbox/ folder, commit and push.
......@@ -3,5 +3,5 @@ markdown: kramdown
permalink: pretty
# Build settings
destination: ../www
destination: ../www-sandbox
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