From 2b35c29e6a3b16ede86e6fc5627097b8fc997d4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hampus=20N=C3=A4sstr=C3=B6m?= Date: Mon, 30 Sep 2024 18:56:12 +0200 Subject: [PATCH] Added small TOC --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3baa4f3..0a8e68d 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,12 @@ and how to customize it through [adding plugins](#adding-a-plugin). > greatly appreciate it if you would add the topic `nomad-distribution` by clicking the > ⚙️ next to "About" on the main GitHub page for this repository. +In this README you will find instructions for: +1. [Deploying the distribution](#deploying-the-distribution) +2. [Adding a plugin](#adding-a-plugin) +3. [Updating the distribution from the template](#updating-the-distribution-from-the-template) +4. [Solving common issues](#faqtrouble-shooting) + ## Deploying the distribution Below are instructions for how to deploy this NOMAD Oasis distribution @@ -166,7 +172,7 @@ plugins = [ Once the changes have been committed to the main branch, the new image will automatically be generated. -# Updating an Existing Distribution +## Updating the distribution from the template In order to update an existing distribution with any potential changes in the template you can add a new `git remote` for the template and merge with that one while allowing for unrelated histories: