To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 214768fa authored by Sandro Lutz's avatar Sandro Lutz
Browse files

Restructuring of content files

parent 8d071682
......@@ -4,6 +4,10 @@ This is the home of the new AMIV website.
## How to use
### Update Content
[See this guide for further instructions](src/content/)
### Development
```bash
......
# AMIV Website: Static Content
This directory contains all content which is prone to change regularly. Normally, only files within this directory have to be changed.
Please change all required files an commit them at once. If you want to do it over the web interface, please use the [GitLab IDE](https://gitlab.ethz.ch/-/ide/project/amiv/amiv-website/edit/master/).
Follow the links below to see further instructions:
* [Change company profiles](companies)
* [Change content in subsection `amiv`](amiv)
# AMIV Website: Update Board Page
For every image, there exist an object (indicated by curly braces `{}`) with additional information to that image in the file [`data/board.js`](data/board.js).
* **At least one translation** for `description` of a portrait and `tasks` are required. There is no mandatory language.
* **Roles** can be any string. In order that the translation works, please add a translation of the role to the language dictionary files in [`src/languages/`](../../languages/).
* **Image is optional**.
* If there is no image, remove the key-value pair `image` from the object and remove the image resource file from [`images/board/`](images/board/).
* If there is an image available, place it in [`images/board/`](images/board/) and make sure that there is a line like the following at the top of the file [`data/board.js`](data/board.js):
```js
import <imageName> from '../images/board/<file-name>.jpg';
```
_Example:_
```json
{
image: someImage,
portraits: [
{
role: 'President',
name: 'Zoidberg',
description: {
de: 'Dies ist ein markdown Text.',
en: 'This is some markdown text.',
},
},
{
role: 'Quaestor',
name: 'Leela',
description: {
de: 'Dies ist ein anderer Text.',
en: 'This is another text.',
},
},
],
tasks: {
de: `
_Beschreibung der Aufgaben des Präsidenten._
_Beschreibung der Aufgaben des Qästors._`,
en: '_Description of the tasks of the president._\n\n_Description of the tasks of the quaestor._',
},
}
```
Make sure that at the top of the file, there is a line like:
```js
import someImage from '../images/board/pq.jpg';
```
# AMIV Website: Update Commissions Page
For every commission, there exist an object (indicated by curly braces `{}`) with additional information in the file [`data/commissions.js`](data/commissions.js).
* **At least one translation** for `description` is required. There is no mandatory language.
* **Name** is required and can be any string.
* **Website is optional**. If there is not website available, remove the key-value pair `website` from the object. (ONLY WEBSITES MAINTAINED BY THE COMMISSION HERE!)
* **Email is optional**. If there is no email address available, remove the key-value pair `email` from the object. (ONLY @amiv.ethz.ch EMAIL ADDRESSE HERE!)
* **Phone is optional**. If there is no phone number availabe, remove the key-value pair `website` from the object. (NO PRIVATE PHONE NUMBERS HERE!)
* **Image is optional**.
* If there is no image, remove the key-value pair `image` from the object and remove the image resource file from [`images/commissions/`](images/commissions/).
* If there is an image available, place it in [`images/commissions/`](images/commissions/) and make sure that there is a line like the following at the top of the file [`data/commissions.js`](data/commissions.js):
```js
import <imageName> from '../images/commissions/<file-name>.jpg';
```
_Example:_
```json
{
name: 'Bastli',
image: someImage,
description: {
en: 'This is a description',
de: 'Dies ist eine Beschreibung',
},
website: 'https://bastli.ethz.ch',
email: 'info@bastli.ethz.ch',
phone: '+41 44 632 49 41',
},
```
Make sure that at the top of the file, there is a line like:
```js
import someImage from '../images/commissions/bastli.jpg';
```
\ No newline at end of file
# AMIV Website: How to change section `AMIV`
## Update Board Page
[See the BOARD guide for further instructions](BOARD.md)
## Update Commissions Page
[See the COMMISSIONS guide for further instructions](COMMISSIONS.md)
## Update `About AMIV`
**IMPORTANT** Always edit both files at the same time. There must not be any mismatch in information between the two translations!
Please edit the files [`markdown/about.de.md`](markdown/about.de.md) and [`markdown/about.en.md`](markdown/about.en.md).
## Update the statutes
To update the statutes, regenerate the html file from the [LaTeX source](https://gitlab.ethz.ch/amiv/amiv-statuten) and exchange the file [`html/statutes.html`](html/statutes) with the newly generated version.
# Company profiles HowTo
# AMIV Website: How to Company profile
## Add/update a company profile
......
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