How to Contribute to this website

The CRLab website needs you to keep it up-to-date with the latest information about the lab. This wiki page will walk you through everything you need to know!

To get started working on this website

Install Hugo (exenteded edition)
Install NodeJS
Clone the CRLab repository
Start a local development server with hugo server and visit http://localhost:1313
Changes pushed to the gh-pages branch will be automatically build by the CI/CD pipeline and will display on the website in a couple of minutes

Team Members

The team page is a space for CRLab staff & researchers to write a bio on themselves. To create a new profile, upload a markdown file and profile image to the /content/team/ directory.

Each markdown file must include the mandatory front matter.

Parameter	Mandatory/ Optional	Description
`name`	Mandatory	Full name of the team member. This must be unique and is used to link authors with projects & wiki content
`weight`	Optional	Alters the display order of the team member page (normally alphabetical)
`params.img`	Mandatory	Profile photo. Photo must be in the `/content/team/` directory
`params.type`	Mandatory	Must be `staff` or `research-student` to show on the team page, otherwise free text
`params.role`	Optional	Overwrites the Staff or Research Student roles with custom text
`params.linkedin`	Optional	LinkedIn username. Shows LinkedIn icon
`params.orcid`	Optional	OrcId. Shows OrcId icon
`params.email`	Optional	Email address. Shows email icon

Example with all fields set

---
name: Damith Herath
weight: 1
params:
    role: Founder/Lead Collaborative Robotics Lab
    type: staff
    img: damith-herath.jpg
    linkedin: damithherath
    orcid: 0000-0002-7509-5265
    email: damith.herath@canberra.edu.au
---

Developing Team Member Pages

File	Purpose
`/layouts/_default/team.html`	Renders the team page
`/layouts/team/single.html`	Renders the team member page and finds the members projects
`/layouts/partials/content/team.html`	Team introduction text
`/layouts/partials/bio/bio.html`	Renders each team member card

Project Pages

The projects page is a place to showcast the CRLab’s robotics research projects.

To create a new project, create a new markdown file in the /content/projects/ directory.

Each markdown file must include the mandatory front matter.

Parameter	Mandatory/ Optional	Description
`title`	Mandatory	Title of the projects. Is used throughout all project cards
`summary`	Optional	Overwrites the automatically generated summary if present. Is shown on project cards
`date`	Optional	Will show as a date on the card. See Hugo Dates
`author`	Optional	Highly recommended. Name must exactly match the team member name to show on the team members page. Multiple authors can be comma seperated
`params.img`	Optional	Highly recommended. Renders in project cards and on the project page as the hero image. Must be the full path to the image (i.e. if `image.png` is in the `/content/projects/` folder, the image path is `/projects/image.png`)

Developing Project Pages

File	Purpose
`/content/projects/_index.md`	Content shown above the project list on the projects page
`/layouts/_default/single.html`	Renders the project page and includes the author block at the bottom
`/layouts/partials/bio/bio-inline.html`	Renders the author bio card
`/layouts/partials/page.html`	Renders the project card (as shown on the projects page)

Wiki Pages

Same as Project Pages but pages are not included on the authors bio page and /content/wiki/_index.md controls the displayed content on the Wiki page.

Other Pages

File	Purpose
`/layouts/_default/home.html`	Home page
`/layouts/partials/content/partnerships.html`	Partnerships section of homepage (currently not implemented)

Markdown

Markdown pages are rendered by Goldmark. See the Markdown Guide for markdown basics.

Some additional shortcodes are supported:

Error, Warning, Note Blocks

This is an error

{{<error>}}
**This is an error**
{{</error>}}

This is an error

{{<warning>}}
**This is a warning**
{{</warning>}}

This is an error

{{<note>}}
**This is a note**
{{</note>}}

Raw HTML

To include raw html (e.g. iframes), wrap it in a rawhtml block.

{{<rawhtml>}}
...
{{</rawhtml>}}