From 4c65e987c479f5f13316e6c92210cf7bf20dfdde Mon Sep 17 00:00:00 2001
From: sarahffm <58327878+sarahffm@users.noreply.github.com>
Date: Fri, 30 Sep 2022 11:51:50 +0200
Subject: [PATCH] #826: Update IDE-mirrors documentation (#915)

---
 .../devonfw-ide-contribution-getting-started.asciidoc         | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/documentation/devonfw-ide-contribution-getting-started.asciidoc b/documentation/devonfw-ide-contribution-getting-started.asciidoc
index 1c684851c..ea798d524 100644
--- a/documentation/devonfw-ide-contribution-getting-started.asciidoc
+++ b/documentation/devonfw-ide-contribution-getting-started.asciidoc
@@ -88,6 +88,10 @@ For a new tool create a folder in https://github.com/devonfw/ide-mirrors[ide-mir
 * `os-mapping` contains the remapping from OS to the value filled into the `${os}` placeholder of the URL. So you can e.g. remap `windows=win` or `mac=darwin` in case the download URLs do not follow common practices. You can even omit this file to fall back to the default https://github.com/devonfw/ide-mirrors/blob/master/os-mappings[os-mappings].
 * `arch-mapping` contains the remapping from architecture to the value filled into the `${arch}` placeholder of the URL. So you can e.g. remap `aarch64=arm64` or `x86_64=x64` in case the download URLs do not follow common practices. Simply omit this file if not needed.
 * `versions` in very special cases, you can create separate configurations in sub-folders for specific versions or version-ranges. Here you can specify a folder-name followed by a less-sign (`<`) and a version number to specify that if the version to install is less than this given version, the configuration will be read from that specified folder. The lines are processed top-down where the first match applies. An example can be found https://github.com/devonfw/ide-mirrors/blob/master/java/versions[here].
+* `versions-url` contains the url where all available versions can be found. If possible, check if the tool is available via the GitHub API (`https://api.github.com/repos/<organisation>/<repository>/releases`). If that's not possible, provide a different url as well as the `versions-url-op` for this url.
+* `versions-url-op` contains the command used to extract the versions from the response of `curl $versions-url` in a suitable format. This file is always required if you didn't use the GitHub API for the `versions-url`. In case you used the GitHub API, you only have to create this file if the standardized approach doesn't work (e.g. versions have the wrong format, there are versions left that need to be removed, ...).
+
+The file `available-versions` doesn't have to be created manually. Using the `versions-url` and `versions-url-op`, `available-versions` will be generated and updated automatically by a GitHub Actions workflow.
 
 It is important that the line endings of all files are UNIX `\n`.