TUD Cyber Analytics Lab

This is the repository for the CA lab's website. It is deployed using github.pages and borrows open source themes.

Usage

Adding a new lab member

1. Add the member's picture in the /assets/people/ folder. If no picture is available, use either female-no.png or male-no.png as default. (!! Make sure the picture has equal dimensions, width == height!!)
2. Make a file with the member's information (name, position, etc.) and place it in the _people folder (Changes in _config.yml are no longer supported).
3. Fill the filename in pic field,
4. and assign them a role from the given roles collection in _config.yml. You can even add a new role.
5. Optionally, also add the links to their personal webpage.
6. Commit the changes.

Adjusting picture size

1. Open PowerPoint and insert your picture from the Insert menu
2. Select Crop -> Aspect ratio -> 1:1 and adjust the cropped area
3. Then, select Crop -> Crop to shape -> Oval
4. Finally, right-click, choose Save as picture, and store it in the assets/people/ folder.

Adding a new project

1. Add the new file under /_posts/ folder with the specific naming convention %YYYY-%MM-%DD-projectname.md.
2. Add the following meta-data: title, categories (for the title of the project and whether the project is ongoing or finished)
3. There are also options to put an image. The image path goes in project-pic. Set show-in-list to true to display the picture in project list and set aside-own to true to display the picture in the project description page.
4. Also add the default meta-data: layout: post and feature-image (see from other copies)
5. Add the project description in the main body and commit the changes.

Adding a new publication

1. Add the new file under /_papers/ folder with the specific naming convention %YYYY-smallname.md.
2. Add the following meta-data: title, author_list, venue, year, code_link, {paper_link or pre_link} (for the title, comma-separated author list, full venue name, year of publication, link to the source code (if any), and the link to either the pre-print or the published version of the manuscript)
3. Also add the default meta-data: layout: paper and feature-image (see from other copies)
4. Add a short abstract summary in the main body and commit the changes.

Adding a new tool

1. Add the new file under /_tools/ folder.
2. Add the following meta-data: title, code_link (for the name of the tool and the link to the source code)
3. Also add the default meta-data: layout: tools and feature-image (see from other copies)
4. Add a short tool description in the main body and commit the changes.

Adding a new blog entry

1. Add the new file under /_blogposts/ folder with the specific naming convention %YYYY-%MM-%DD-entryname.md. (Only the date is rendered)
2. Add the following meta-data: title, author (for the title of the entry and author's name)
3. Also add the default meta-data: layout: blogpost and feature-image (see from other copies)
4. Add the blog text in the main body and commit the changes.

Adding a new recent news item

1. Add the new entry in the index.md file under Recent News.

Editing contact details or advertise a new position

1. Make the corresponding updates in the contact.md file.

Structure

** (outdated)

Folders

• _data: Contains the configuration file for fonts and the color scheme for the website text
• _includes: Whenever some .html content needs to be rendered in .md file, the .html goes here. It also contains /css/agency.css file with the primary style guide for the whole website.
• _layouts: Contains the various layouts (templates) for the webpages, e.g. how the project entries, and the team page will render. These files contain a mix of Jekyll and HTML code.
• projects: Contains the file that renders the project page containing a collection of project entries.
• _posts: The individual entries for each project are contained here. The file names typically follow the following format %YYYY-%MM-%DD-projectname.md. We don't render the dates anymore.
• _people: The team members' information is placed in this folder. One file for each person.
• assets: Contains images and scripts used by the webpages.
• css: Contains font-awesome style guides
• js: Contains the jQuery and Bootstrap scripts for stylizing the webpages.

Files

• _config.yml: The main configuration file. It contains the navigation layout, the group name, and specifies the collection used by project, papers and team entries. It also contains the theme related information, i.e. the Jekyll plugins and settings used.
• index.md: This is the Home page when the website is loaded
• people.md: This is the page called when the People link is clicked. This page calls the layout and other files to render the Team page.
• contact.md: This page is called when Contact link is clicked. This page calls the layout and other files needed to render the Contact us page properly.
• categories.md: If a project category is clicked, all related projects are shown. This page calls the layout and other script to make that happen.