Add README for more info.

Kristof Goossensrequested to merge
add-readme into main

Why is this change being made?

💡 CoderDojo Belgium Handbook site uses Hugo for static page generate from Markdown. The sites base theme is Docsy and we have custom theme overrides which sit on top of this. Docsy and Hugo extended both additionally require npm.

Author and Reviewer Checklist

Please verify the check list and ensure to tick them off before the MR is merged.

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is [SAFE][SAFE]
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in [#mr-buddies][mr-buddies-slack]
    • The [when to get approval][when-to-get-approval] handbook section explains the workflow in more detail
  • For transparency, share this MR with the audience that will be impacted.
    • Team: For changes that affect your direct team, share in your group Slack channel
    • Department: If the update affects your department, share the MR in your department Slack channel
    • Company: If the update affects all (or the majority of) GitLab team members, post an update in [#whats-happening-at-gitlab][whats-happening-at-gitlab-slack] linking to this MR
      • For high-priority company-wide announcements work with the [internal communications][internal-communications] team to post the update in [#company-fyi][company-fyi-slack] and align on a plan to circulate in additional channels like the ["While You Were Iterating" Newsletter][engagement-channels]

Diff

Introduction

  • Added a new section "CoderDojo Belgium Handbook"
  • Added a new subsection "Introduction"
  • Added a new paragraph explaining the purpose of the handbook site
  • Added a new paragraph explaining the technologies used to build the site

Requirements

  • Added a new section "Requirements"
  • Added a new subsection "Git"
  • Added a new subsection "Docker"
  • Added a new subsection "Hugo Extended"
  • Added a new subsection "NPM/Node.JS"

Getting started

  • Added a new section "Getting started"
  • Added a new subsection "Running Hugo"
  • Added a new subsection "Clone this repo"
  • Added a new subsection "Setup the repository"
  • Added a new subsection "Fire up Hugo server"
  • Added a new subsection "Generate the site locally"
  • Added a new subsection "Running Markdown Lint"

Support

  • Added a new section "Support"
  • Added a new paragraph explaining how to get help and support with the new repo

Contribution guidelines

  • Added a new section "Contribution guidelines"
  • Added a new paragraph explaining the contribution guidelines for the handbook

This description was generated for revision e0b65953 using AI

Merge request reports