From 17bfba48c3be0db77c4bf28d6494c49773c707b1 Mon Sep 17 00:00:00 2001 From: Martin Vidner Date: Fri, 20 Jun 2025 10:50:12 +0200 Subject: [PATCH 1/3] fix admonition (Note) syntax not to swallow the rest of the document, including footnotes https://docusaurus.io/docs/markdown-features/admonitions --- docs/user/urls.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/user/urls.md b/docs/user/urls.md index 3b486a2..ee30b42 100644 --- a/docs/user/urls.md +++ b/docs/user/urls.md @@ -90,8 +90,10 @@ hd:/sles.jsonnet?devices=/dev/sr0 dvd:/autoinst.xml?devices=sr1 ``` -:::note Prefer `device` to `cd`, `dvd` or `hd` Given that `cd`, `dvd` and `hd` do not offer any -advantage, using `device` might be a better option. ::: +:::note +Prefer `device` to `cd`, `dvd` or `hd` Given that `cd`, `dvd` and `hd` do not offer any +advantage, using `device` might be a better option. +::: ### Not supported yet From 826093361bf3936dc19f0485c7cf98343e62a9c3 Mon Sep 17 00:00:00 2001 From: Martin Vidner Date: Fri, 20 Jun 2025 10:51:36 +0200 Subject: [PATCH 2/3] mention relative references, as replacement for relurl --- docs/user/urls.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/user/urls.md b/docs/user/urls.md index ee30b42..6c4c569 100644 --- a/docs/user/urls.md +++ b/docs/user/urls.md @@ -27,6 +27,13 @@ In addition to those schemes, Agama supports a set of specific ones which can be - [`label`](#label) for finding files in a file system with a given label. - [`cd`, `dvd`, `hd`](#cd-dvd-and-hd) for finding files on specific devices (prefer `device`). +## Relative references + +For `"scripts"` and `"files"` in the Agama JSON config, the `"url"` property +can be a relative reference, where the resolution base is the URL of the containing config. + +This is a replacement for the ~~`relurl`~~ scheme used in AutoYaST. + ## Agama specific schemes The typical protocols are enough for most use cases. However, more specific URLs can be handy in @@ -97,7 +104,7 @@ advantage, using `device` might be a better option. ### Not supported yet -The `repo://` and `relurl://` URLs are not supported yet, but there are plans to implement them. +The `repo://` URLs are not supported yet, but there are plans to implement them. [^1]: Agama relies on [curl](https://curl.se/) to support generic protocols (network protocols and `file://`). So it might happen that some protocol is supported "by accident". However, only the From af28612f2d4e8f83b34962b89c3f174a4245a1b6 Mon Sep 17 00:00:00 2001 From: Martin Vidner Date: Mon, 21 Jul 2025 18:33:13 +0200 Subject: [PATCH 3/3] example of a relative reference --- docs/user/urls.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/user/urls.md b/docs/user/urls.md index 6c4c569..f9f404e 100644 --- a/docs/user/urls.md +++ b/docs/user/urls.md @@ -34,6 +34,23 @@ can be a relative reference, where the resolution base is the URL of the contain This is a replacement for the ~~`relurl`~~ scheme used in AutoYaST. +For example, if the configuration below is retrieved from +`https://example.com/machines/sles16.jsonnet`, it refers to +`https://example.com/machines/scripts/snapshot.sh`. + +```jsonnet +{ + scripts: { + postPartitioning: [ + { + name: "snapshot", + url: "scripts/snapshot.sh" + } + ] + } +} +``` + ## Agama specific schemes The typical protocols are enough for most use cases. However, more specific URLs can be handy in