demodam.org

This site is a collaborative project by the Demodam community and is meant to be easy to contribute to. The Demodam showcase website will be at demodam.nl. The project governance will be hosted here at demodam.org.

For more information:

• The goals and governance of Demodam
• Article in Dutch, announcing Demodam
• Find out how you can join and contribute
• How to become a Demodam Organization (in draft status)
• Sign up for the first Demodam hackathon 5-9 June
• Kickoff workshop Miro board

You can submit a pull requests on GitHub if you have content for this page.

For questions: [email protected]

Getting started

The website code is a copy of the Signalen website repository, built by the authors and contributors.

Building, testing and deploying

This site is built using Gatsby. First make sure you have Node installed on your machine. Then install the dependencies with the npm install command. After this you can use the npm start to start a local webserver and build/update the site.

The website is automatically deployed when a push is done to main using a combination Github actions. The workflow for this is configured in .github/workflows/deploy.yml. A deploy script is added to package.json with the line "deploy": "gatsby build" . More info about the implementation or additional configuration options refer to https://github.com/marketplace/actions/gatsby-publish.

Pull request to any branch of this repository are automatically tested by building the Gatsby site using Github actions. The workflow for this is configured in .github/workflows/test.yml

Gitflow proces

When you want to contribute to the website make sure you:

1. Clone 'main'
2. Create a branch to work on
3. Push changes to your branch
4. Create a pull request against 'main'

How to add a news article to the website

You can add a news article to the website by adding a Markdown document to the pages/news/ folder. The news section of the website has multilingual support. Copy an existing file and edit it. Use the following filename convention: YYYY-MM-DD-filename.en.md

Make sure the document includes the following frontmatter:

---
path: "/en/news/2021-02-11-filename/"
date: "2021-02-11"
title: "Welcome to the Signalen news"
lang: en
template: default

Make sure you set the path and lang parameters. The lang is used to filter out the specific posts for a particular language. If you want to provide a Dutch version of your news article make sure you prefix the path with nl and your filename includes a language local using the following convention: YYYY-MM-DD-filename.md (NOTE: that for the default language set in Gatsby config you don't need to include language code in the filename)

Example:

---
path: "/news/2021-02-11-filename/"
date: "2021-02-11"
title: "Welkom bij het Demodam blog"
lang: nl
template: default

For more information on how the news section is implemented refer to (https://www.gatsbyjs.com/blog/2017-07-19-creating-a-blog-with-gatsby/). For more information on how multilingual support is implemented refer to the section 'Localization'

Localization

This site has basic multilingual support using the gatsby-plugin-i18n. It is implemented by the guidelines written in this blogpost: https://www.gatsbyjs.com/blog/2020-02-19-how-to-build-multilingual-sites-with-gatsby/

You can start your won translation by prefixing the extensions of files which serve up pages by using the ISO country codes. Files which do not include such a prefix will be defaulted to the language as configured in the gatbsy-config.js file.

index.en.js serves the english equivalent of that page.

The plugin makes all the language specific files available under the site-root/ so in the case of english site-root/en/.

Navigation menu

The navigation menu uses a a key-value list to translate the separate navigation items. The pages/menu.json file contains all the items and translations. To add a new language simply copy another language array, insert the language code and make the language specific translations.

"nl": [
  {
    "title": "Over Demodam",
    "link": "/#over-demodam",
    "partiallyActive": false
  },

The footer part of the website is generated using the values listed in the menu.json file.

IMPORTANT: Internal linking from within markdown files ot other markdown files.

Markdown files in the pages folder are converted to HTML during build time using the /templates/default.js script. Note that when you refer from one markdown file to the other always to include a trailing slash or the GraphQL query will fail and result in a failing build.

Imported pages do not automatically resolve to language specific versions

Imports in pages need to be referenced explicitly and do not resolve automatically.

For example import Payoff from '../components/Payoff/ will always resolve to import Payoff from '../components/Payoff/index.js. So if you need to reference a language specific version you should indicate the filename import Payoff from '../components/Payoff/index.en.js.

In order to add a translation refer to all English related files and make a copy of them including the new language code. Check the import statements in the page to check whether they point to the correct translated version of that file.

In the current configuration only the Payoff component and the roadmap page and component needs to be translated in this fashion.

More information about the configuration and implementation can be found here: https://www.gatsbyjs.com/blog/2020-02-19-how-to-build-multilingual-sites-with-gatsby/

License

© The authors and contributors

Licensed under EUPLv1.2.