Skip to content

Editing the website

Edwin Shepherd edited this page Feb 18, 2020 · 5 revisions

Getting Started

If a user has not edited the website before please follow the instructions avaliable at: https://github.com/systemetric/robocon-website/wiki/Adding-new-users-to-the-website

There are two main ways to edit the content of the website. The files can be manipulated directly in the robocon-website git repository, see: https://github.com/systemetric/robocon-website

Alternatively if you aren't familiar with git you can use the CMS (Content Management System). This gui can be quite slow and cumbersome though if you just want to edit a sentence. However it does come with the nice benefit of being able to see in real time your edits.

Using the CMS

To alter the website Go-To https://hr-robocon.org/admin/ and sign-in using an account with push access to this repository. This will let you into the CMS (Content Management System) for the website. The pages are organised by category in the left side bar. You can view the contents of a page by clicking on it.

You can see that the page structure in two modes markdown and Rich Text. Select your prefered editing mode and you can alter the page as you wish. When you are done click publish, the changes that you have made will take a few minutes to process, you will see a notification in the bots#netlify channel on the discord server when they are done.

Reviews

Clicking on the workflow tab at the top will allow you to have a review process with other users.

Embedding things

To embed content into the website use the following tags in the markdown editing mode.

General HTML

<Embed :aspect-ratio="1/1.4142">
HTML-CODE-YOU-WANT-TO-EMBED
</Embed>

YouTube Videos

<YouTube id="THE-ID-OF-THE-VIDEO" />

Using git

Anything which is pushed to master will automatically be deployed though it can take a few minutes to deploy. It is strongly advised to submit your changes as a pull request so the CI can run before you merge. This will offer you a preview of the site before you deploy and any changes corrective changes can be made without first breaking the site.