From 8fe132323b95599d85f7a97dd13958a17cb25dfe Mon Sep 17 00:00:00 2001 From: Diogo Constantino Date: Sun, 15 Jan 2023 18:30:19 +0000 Subject: [PATCH 1/4] Add new file --- Readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..2324f87 --- /dev/null +++ b/Readme.md @@ -0,0 +1,9 @@ +# Como contribuir para o sítio Web da ANSOL + +## Novo evento para a agenda: + +Os eventos são adicionados à agenda criando um novo ficheiro em [content/eventos/](./content/eventos). Adicionalmente pode ser adicionado um ficheiro com uma imagem para "cover", idealmente no formato svg. + +# Licença + +Como podem ver no ficheiro [LICENSE](./LICENSE), o sítio Web da ANSOL está licenciado de com a licença GNU Affero General Public License Version 3 (AGPLv3). From 8acc053dfe53db39a388b7b6fa6ac0d2060841f7 Mon Sep 17 00:00:00 2001 From: Diogo Constantino Date: Sun, 15 Jan 2023 18:50:55 +0000 Subject: [PATCH 2/4] =?UTF-8?q?instru=C3=A7=C3=B5es=20para=20agenda?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Readme.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index 2324f87..8070108 100644 --- a/Readme.md +++ b/Readme.md @@ -2,7 +2,31 @@ ## Novo evento para a agenda: -Os eventos são adicionados à agenda criando um novo ficheiro em [content/eventos/](./content/eventos). Adicionalmente pode ser adicionado um ficheiro com uma imagem para "cover", idealmente no formato svg. +Os eventos são adicionados à agenda criando um novo ficheiro em em formato markdown [content/eventos/](./content/eventos). Adicionalmente pode ser adicionado um ficheiro com uma imagem para "cover", idealmente no formato svg. + +### Requisitos para o ficheiro markdown para o evento + +O ficheiro de markdown para o evento deverá cumprir aos seguintes requisitos: + +1. estar localizado em `content/eventos/` (relativo à raiz do projecto), ou em uma sub-directoria dentro deste caminho (por exemplo "content/eventos/AAAA-MM-DD-megahackaton"). +2. ter o nome de acordo com o seguinte formato: + `AAAA-MM-DD-nome-do-evento.md`; ou no caso de estar dentro de uma subdirectoria, o nome desta deve assumir o formato `AAAA-MM-DD-nome-do-evento` e o ficheiro de markdown deve ter o nome `index.md` +3. o conteúdo do ficheiro de markdown do evento deverá cumprir o seguinte formato: +``` +--- +layout: evento +title: Nome do evento +metadata: + event: + location: Local Mega fixe, Rua super-cool, nº 1 2A, 9999-999 Cidade + site: + url: https://website.do.evento.org/ + date: + start: AAAA-MM-DD HH:MM + finish: AAAA-MM-DD HH:MM +--- +``` +4. caso seja adicionado um ficheiro de imagem como cover, então deve ser utilizada a opção de colocar quer o ficheiro markdown quer o ficheiro de imagem, dentro da uma sub-directoria de `content/eventos`, seguir as recomendações anteriores para esse caso e colocar a imagem (idealmente em formato svg), dentro da subdirectoria do evento. # Licença From 901b1cf23e08d786a78be18aa293588c97ad53b4 Mon Sep 17 00:00:00 2001 From: Diogo Constantino Date: Sun, 15 Jan 2023 19:14:44 +0000 Subject: [PATCH 3/4] Update file Readme.md --- Readme.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/Readme.md b/Readme.md index 8070108..0166854 100644 --- a/Readme.md +++ b/Readme.md @@ -4,14 +4,10 @@ Os eventos são adicionados à agenda criando um novo ficheiro em em formato markdown [content/eventos/](./content/eventos). Adicionalmente pode ser adicionado um ficheiro com uma imagem para "cover", idealmente no formato svg. -### Requisitos para o ficheiro markdown para o evento +### Instruções -O ficheiro de markdown para o evento deverá cumprir aos seguintes requisitos: - -1. estar localizado em `content/eventos/` (relativo à raiz do projecto), ou em uma sub-directoria dentro deste caminho (por exemplo "content/eventos/AAAA-MM-DD-megahackaton"). -2. ter o nome de acordo com o seguinte formato: - `AAAA-MM-DD-nome-do-evento.md`; ou no caso de estar dentro de uma subdirectoria, o nome desta deve assumir o formato `AAAA-MM-DD-nome-do-evento` e o ficheiro de markdown deve ter o nome `index.md` -3. o conteúdo do ficheiro de markdown do evento deverá cumprir o seguinte formato: +1. criar umas directoria em `content/eventos/`, dedicada ao evento (por exemplo "content/eventos/AAAA-MM-DD-megahackaton"). +2. na sub-directoria de evento deverá ser criado um ficheiro chamado index.md, com o conteúdo como este template de exemplo: ``` --- layout: evento @@ -22,11 +18,24 @@ metadata: site: url: https://website.do.evento.org/ date: - start: AAAA-MM-DD HH:MM - finish: AAAA-MM-DD HH:MM + start: AAAA-MM-DD + finish: AAAA-MM-DD --- ``` -4. caso seja adicionado um ficheiro de imagem como cover, então deve ser utilizada a opção de colocar quer o ficheiro markdown quer o ficheiro de imagem, dentro da uma sub-directoria de `content/eventos`, seguir as recomendações anteriores para esse caso e colocar a imagem (idealmente em formato svg), dentro da subdirectoria do evento. +3. caso haja uma imagem de cover, ela deve ser colocada na directoria do evento e ter o nome `cover` (por exemplo: cover.svg, ou cover.png). + + +Exemplo de layout de ficheiros: +``` +content/eventos/ + . + .. + AAAA-MM-DD-megahackaton/ + . + .. + index.md + cover.svg +``` # Licença From b4d312cab35cb0cba7e01a3c17b35969241ebcc5 Mon Sep 17 00:00:00 2001 From: Diogo Constantino Date: Sun, 15 Jan 2023 19:17:17 +0000 Subject: [PATCH 4/4] =?UTF-8?q?ilustra=C3=A7=C3=A3o=20de=20exemplo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Readme.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 0166854..cae1cea 100644 --- a/Readme.md +++ b/Readme.md @@ -24,8 +24,7 @@ metadata: ``` 3. caso haja uma imagem de cover, ela deve ser colocada na directoria do evento e ter o nome `cover` (por exemplo: cover.svg, ou cover.png). - -Exemplo de layout de ficheiros: +Exemplo de layout de ficheiros para um evento na agenda: ``` content/eventos/ .