Skip to content

Commit

Permalink
Merge pull request #143 from elixir-europe-training/review-editorial-…
Browse files Browse the repository at this point in the history
…guidelines

Review editorial guidelines
  • Loading branch information
abotzki authored Dec 4, 2024
2 parents aebbaaf + f16dfb7 commit f9573f6
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 19 deletions.
2 changes: 1 addition & 1 deletion pages/about/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ ELIXIR Training SPLASH was developed with funding from ELIXIR BioHackathon Europ
The ELIXIR Training SPLASH makes all of their materials publicly available under [Open Source Initiative](https://opensource.org/licenses) licenses.
The process documents and data are made available under a [CC-BY](https://creativecommons.org/licenses/by/4.0/) license.
Software are made available under an [MIT license](https://opensource.org/licenses/mit-license.html).
For full details on licensing, please visit our [License document](https://github.com/elixir-europe/rdmkit/blob/master/LICENSE).
For full details on licensing, please visit our [License document](https://github.com/elixir-europe/training-splash/blob/master/LICENSE).

6 changes: 3 additions & 3 deletions pages/about/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ The website is a community effort, so unfortunately we do not have the resources
* [The Web Content Accessibility Guidelines](https://www.w3.org/TR/WCAG21/)
* [AccessibilityTest.org](https://accessibilitytest.org), which runs several online accessibility checkers at once.

The website was last tested on 2023.
The website was last tested on 2024.

## Level of compliance
As far as we can ascertain, this website is compliant with the Web Content Accessibility Guidelines version 2.1 AA standard. If you feel there are issues to address, however, then please email [rdm-editors@elixir-europe.org](mailto:rdm-editors@elixir-europe.org).
As far as we can ascertain, this website is compliant with the Web Content Accessibility Guidelines version 2.1 AA standard. If you feel there are issues to address, however, then please email [training-splash@elixir-europe.org](mailto:training-splash@elixir-europe.org).

This statement was prepared on 2023.
This statement was last updated in 2024.
2 changes: 1 addition & 1 deletion pages/about/editorial_board.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Editorial board

## Meet the editorial board members

{% include contributor-carousel-selection.html custom="Alexia Cardona, Mihail Anton, Alexander Botzki"%}
{% include contributor-carousel-selection.html custom="Alexia Cardona, Elin Kronander, Alexander Botzki"%}

## Join as editorial board member

Expand Down
2 changes: 0 additions & 2 deletions pages/contribute/copyright.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,3 @@ If you are using a stock image you have bought, or a royalty-free image, check t
You are welcome to create the images yourself, but please follow the [site style guide](style_guide), and bear in mind the image may be modified to better suite the style of the site. The content of the site is published under the [Creative Commons 4 license](https://creativecommons.org/licenses/by/4.0/).

If you think an image would be helpful to explain your content but you cannot find the right one, then [create a new issue](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/issues) to suggest a new image.


14 changes: 7 additions & 7 deletions pages/contribute/editorial_board_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ summary: This guide is there to help editors.

### General rules

As an editor, try to work as much as possible on a different branch than the master branch. This can be on the elixir-europe training SPLASH repo or your own fork. Open a pull request if you want to merge your changes with the master branch. This way it is possible for other editors to give feedback on your changes. Typos or other small fixes can of course be done immediately on the master branch.
As an editor, try to work as much as possible on a different branch than the main branch. This can be on the ELIXIR Europe Training SPLASH repository or your own fork. Open a pull request if you want to merge your changes with the main branch. This way it is possible for other editors to give feedback on your changes. Typos or other small fixes can of course be done immediately on the main branch.

### Overview of the file structure in GitHub

The content of the website is built up using markdown files found in the [pages](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/tree/main/pages) directory.
These markdown files are divided over subdirectories (your_role, your_tools, your_tasks...) for sorting reasons only.
These markdown files are divided over subdirectories for sorting reasons only.

### Markdown file naming

Expand Down Expand Up @@ -51,14 +51,14 @@ For more information about this topic please visit the [GitHub documentation pag
### Simple way: using the GitHub interface
To generate a new page it is sufficient to simply copy the TEMPLATE file in the subdirectory and rename it. To copy a template you have to:

1. Go to the `TEMPLATE_` file of choice in the [GitHub repo](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/tree/main/pages), every section has its own TEMPLATE file. For example the [TEMPLATE_your_tasks.md](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/tree/main/pages/your_tasks/TEMPLATE_your_tasks.md) file.
1. Go to the `TEMPLATE_` file of choice in the [GitHub repo](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/tree/main/pages), every section has its own TEMPLATE file. For example the [TEMPLATE_resource_page.md](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/tree/main/pages/resources/TEMPLATE_resource_page.md) file.

1. Click "Raw" on the GitHub page to open the file 'as is'
{% include image.html file="raw_github.png" inline=true alt="Raw button GitHub." %}

1. Select and copy all the content.

1. Go back to the main section were you want to make the new page, in our example this will be in */pages/your_tasks*. Click on `Add file` on the right followed up by `Create new file`.
1. Go back to the main section were you want to make the new page, in our example this will be in */pages/resources*. Click on `Add file` on the right followed up by `Create new file`.
{% include image.html file="create_new_file_github.png" inline=true alt="Create new file GitHub." %}

1. Paste the copied content from the template.
Expand Down Expand Up @@ -144,11 +144,11 @@ Alexia Cordona:
Institutions, projects, funders and infrastructures are listed in the [affiliations.yml](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/blob/master/_data/affiliations.yaml) file. The info in this file is used on the support page in the about section, but also for the affiliations in tool assembly pages. Make sure you make use of the same name in those assembly pages. The yaml file has following syntax:
```yaml
- name: VIB
image_url: /images/institutions/VIB-PSB.svg
image_url: /images/institutions/vib.svg
pid: https://ror.org/03xrhmk39
expose: true
type: institution
url: https://www.psb.ugent.be/
url: https://www.vib.be/
```
- `name`: name
Expand All @@ -159,7 +159,7 @@ Institutions, projects, funders and infrastructures are listed in the [affiliati
- `url`: url towards the homepage of this association


The logos can be added to the [/images/institutions](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/blob/master/images/institutions/), [/images/projects](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH//blob/master/images/projects/), [/images/infrastructures](https://github.com/eelixir-europe-training/ELIXIR-Training-SPLASH/blob/master/images/infrastructures/) and [/images/funders](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH//blob/master/images/funders/) directory.
The logos can be added to the [/images/institutions](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/blob/main/images/institutions/), [/images/projects](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/blob/main/images/projects/), [/images/infrastructures](https://github.com/eelixir-europe-training/ELIXIR-Training-SPLASH/blob/main/images/infrastructures/) and [/images/funders](https://github.com/elixir-europe-training/ELIXIR-Training-SPLASH/blob/main/images/funders/) directory.

{% include callout.html type="important" content="Upload vector images (.svg filetype) of the institute logo for better quality, scaleability and file size, if possible." %}

Expand Down
2 changes: 1 addition & 1 deletion pages/contribute/how_to_contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Everyone is welcome to contribute to this site, and we've tried to make it as ea

* **If you are not familiar with Git** but want to give it a try on GitHub: follow [our step-by-step instructions](github_way) (no technical knowledge required!).
* **If you are familiar with Git**: fork the repo and create a pull request (see our [instructions](working_with_git)).
* **If you just want to make a quick suggestion**: submit your comments/suggestions using the form below.
* **If you just want to make a quick suggestion**: submit your comments/suggestions using an issue as deescribed below.

## Contributor responsibilities

Expand Down
2 changes: 1 addition & 1 deletion pages/contribute/markdown_cheat_sheet.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Markdown cheat sheet
summary: This is a cheat sheet to showcase what is possible within the markdown pages.
contributors: [Bert Droesbeke, Alexander Botzki]
contributors: [Bert Droesbeke]
search_exclude: true
---

Expand Down
6 changes: 3 additions & 3 deletions pages/contribute/style_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ In general, we follow the European Commission's [Web Writing Style Guide](https:
* **Fonts:** Exo 2 is used for headings and main branding font, Open Sans for body text.
* **Icons:** the icons used in the data life cycle diagram come from the [Noun Project](https://thenounproject.com/ELIXIRCommunications/kit/rdmkit/). We have a Pro license and so the right to publish them without attribution. Other icons on this site come from [Font Awesome](https://fontawesome.com/).
* **Templates:** keep the structure of the pages consistent by using the site templates (see the [contribute page](how_to_contribute)).
* **Illustrations:** use the colours listed above. The icons we use for illustrations come from the [Noun Project](https://thenounproject.com/ELIXIRCommunications/kit/rdmkit/). Please use these icons in any illustrations. If you need extra icons, or any help with illustrations, [open a new issue](https://github.com/elixir-europe/rdmkit/issues) on GitHub or email [rdm-toolkit@elixir-europe.org](mailto:rdm-toolkit@elixir-europe.org).
* **Illustrations:** use the colours listed above. The icons we use for illustrations come from the [Noun Project](https://thenounproject.com/ELIXIRCommunications/kits/splash/). Please use these icons in any illustrations. If you need extra icons, or any help with illustrations, [open a new issue](https://github.com/elixir-europe/training-splash/issues) on GitHub or email [training-splash@elixir-europe.org](mailto:training-splash@elixir-europe.org).
* **Images:**
* Do not use images to display text.
* Include an 'alt' attribute in images.
Expand All @@ -91,5 +91,5 @@ In general, we follow the European Commission's [Web Writing Style Guide](https:
* Should contain the same words as the filename where this title points to.


## How to suggest amendments or additions to this style guide
[Open a new issue](https://github.com/elixir-europe/rdmkit/issues) on GitHub or email [rdm-toolkit@elixir-europe.org](mailto:rdm-toolkit@elixir-europe.org). See also the [contribute page](how_to_contribute).
## How to suggest amendments or additions to this style guide:
[Open a new issue](https://github.com/elixir-europe/training-splash/issues) on GitHub or email [training-splash@elixir-europe.org](mailto:training-splash@elixir-europe.org). See also the [contribute page](how_to_contribute).

0 comments on commit f9573f6

Please sign in to comment.