From 1271f829ea69ad3c91676cf900bae877e7beb843 Mon Sep 17 00:00:00 2001 From: Carlos H Brandt <482051+chbrandt@users.noreply.github.com> Date: Tue, 7 Apr 2026 15:42:47 +0200 Subject: [PATCH] [docs] Fix formatting Fix formatting of info/warning boxes in interlink-configurations Signed-off-by: Carlos H Brandt <482051+chbrandt@users.noreply.github.com> --- docs/docs/guides/11-interlink-configuration.mdx | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/docs/guides/11-interlink-configuration.mdx b/docs/docs/guides/11-interlink-configuration.mdx index b6349aac..fd18165e 100644 --- a/docs/docs/guides/11-interlink-configuration.mdx +++ b/docs/docs/guides/11-interlink-configuration.mdx @@ -112,7 +112,9 @@ The `TLS` section enables secure communication between interLink components: The `JobScriptBuildConfig` section configures container runtime options and job script generation. -:::info What is a Job? A job in this context refers to the execution scripts +:::info What is a Job? + +A job in this context refers to the execution scripts generated by InterLink plugins to run containers on different backend systems (like SLURM, HTCondor, or Docker). The JobScriptBuildConfig allows plugins to customize how these execution scripts are generated and what runtime options are @@ -124,17 +126,23 @@ For example: - **HTCondor plugin**: Creates HTCondor ClassAd files - **Docker plugin**: Builds `docker run` commands - **Apptainer/Singularity plugin**: Constructs `apptainer run` scripts with - specific runtime flags ::: + specific runtime flags + +::: This configuration is optional and only used by plugins that need to generate custom job execution scripts: #### Singularity Hub Configuration -:::warning Plugin-Specific Configuration The Singularity Hub configuration is +:::warning Plugin-Specific Configuration + +The Singularity Hub configuration is specific to Apptainer/Singularity-based plugins. This section may be removed in future versions as it's not used by all plugin types. Consider using -plugin-specific configuration files instead. ::: +plugin-specific configuration files instead. + +::: | Field | Type | Description | | ------------------------ | ------ | --------------------------------------------------------------- |