Skip to content
This repository was archived by the owner on Sep 2, 2024. It is now read-only.

Maintaining Services pages

jCHENEBY edited this page May 5, 2023 · 2 revisions

Structure

Services pages are separated in three categories:

  • E-infrastructure
  • Tools and data resources
  • Data management and data sharing

Content for each services in those categories are defined by a markdown files in pages/services/eInfrastructures, pages/services/tools, pages/services/dataManagementSharing respectively. You should NOT change the names or the location of those directories unless you know what you are doing.

Files in those directories are automatically parsed and added to the services page. The metadata is used to populate the table of content and the content is added to the body of the text in the following order:

  • Every files in eInfrastructures by alphabetical order.
  • Every files in tools by alphabetical order.
  • Every files in dataManagementSharing by alphabetical order.

Content edition

All files added to the parsed directories MUST follow a specific model:

---
title: 'Menu Title'    # How the services name will appear in the table of content
id: 'main-title'       # The identifier of the section
---

### Main title

Three things have to be correctly:

  • title How the services name will appear in the table of content.
  • id Used for internal anchor of the page. It must match the first header of the content (here # Main title) but in lower case, space replace with '-' and special characters such as '@' or '/' must be removed.
  • ### Main title The header of the content. It will appear in the body of the services page and can be different from the title define in the metadata. It needs to be a level 3 title (###)

The rest of the file can be edited as any markdown. Internal links can be used to refer to other services of the body of the page using the value of the id parameters, for example: [link to main title](#main-title) will create an anchor to this section.

It should be noted that the name of the file does note matter.

Clone this wiki locally