From 8c04adefc2a2c1ef948bed7f0db36959c9a54442 Mon Sep 17 00:00:00 2001 From: Smart-City-Muenster <84011331+Smart-City-Muenster@users.noreply.github.com> Date: Thu, 5 Oct 2023 13:03:44 +0200 Subject: [PATCH 1/7] add key components --- docs/standard/schema.core.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index e60d6c13..9e4c0a90 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -64,6 +64,18 @@ See :ref:`forks-and-variants` for a complete description of what is a software variant and how to handle forked software as a parser or an author. +Key ``components`` +~~~~~~~~~~~ + +- Type: array of strings (URLs) +- Presence: optional + +Some software projects are organized in more than one repository. +In addition to the key ``url``, this key gives you an option to specify +more than one URL to further relevant repositories. If you use the key, +you need to specify the URL in the same way as is required for the key ``url``. +You can specify more than URL. + Key ``landingURL`` ~~~~~~~~~~~~~~~~~~ From 63076538b4040a4b2710f53eff4a6895067f46fe Mon Sep 17 00:00:00 2001 From: Smart-City-Muenster <84011331+Smart-City-Muenster@users.noreply.github.com> Date: Thu, 5 Oct 2023 13:07:31 +0200 Subject: [PATCH 2/7] example for key components --- docs/standard/example/publiccode.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/standard/example/publiccode.yml b/docs/standard/example/publiccode.yml index 8d7b5959..b0b2cb73 100644 --- a/docs/standard/example/publiccode.yml +++ b/docs/standard/example/publiccode.yml @@ -3,6 +3,9 @@ publiccodeYmlVersion: "0.2" name: Medusa applicationSuite: MegaProductivitySuite url: "https://example.com/italia/medusa.git" +components: + - "https://example.com/italia/stheno.git" + - "https://example.com/italia/euryale.git" landingURL: "https://example.com/italia/medusa" isBasedOn: "https://github.com/italia/otello.git" softwareVersion: "1.0" From 57d2d1d384c7c3b8df47f031782367c70caee0cd Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Mon, 11 Mar 2024 11:40:29 +0100 Subject: [PATCH 3/7] Paragraph markup --- docs/standard/schema.core.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index 9e4c0a90..f02e80a4 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -65,7 +65,7 @@ is a software variant and how to handle forked software as a parser or an author. Key ``components`` -~~~~~~~~~~~ +~~~~~~~~~~~~~~~~ - Type: array of strings (URLs) - Presence: optional From 3eac4f081f5e1e4c44c5e68c4c0962048d55042d Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Mon, 11 Mar 2024 11:41:18 +0100 Subject: [PATCH 4/7] Fix typo --- docs/standard/schema.core.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index f02e80a4..e3118c56 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -74,7 +74,7 @@ Some software projects are organized in more than one repository. In addition to the key ``url``, this key gives you an option to specify more than one URL to further relevant repositories. If you use the key, you need to specify the URL in the same way as is required for the key ``url``. -You can specify more than URL. +You can specify more than one URL. Key ``landingURL`` ~~~~~~~~~~~~~~~~~~ From 98320a8ab9493bb3def6ef6bf08c458091c5ba11 Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Mon, 11 Mar 2024 11:51:21 +0100 Subject: [PATCH 5/7] Fix title underline --- docs/standard/schema.core.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index e3118c56..7caa7fd2 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -65,7 +65,7 @@ is a software variant and how to handle forked software as a parser or an author. Key ``components`` -~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~ - Type: array of strings (URLs) - Presence: optional From 31c87e4456f709a4afec102c05cb60df93432aa9 Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Mon, 11 Mar 2024 12:07:29 +0100 Subject: [PATCH 6/7] add link to key url --- docs/standard/schema.core.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index 7caa7fd2..8067a814 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -41,6 +41,8 @@ Key ``applicationSuite`` This key contains the name of the “suite” to which the software belongs. +.. _key-url: + Key ``url`` ~~~~~~~~~~~ @@ -71,7 +73,7 @@ Key ``components`` - Presence: optional Some software projects are organized in more than one repository. -In addition to the key ``url``, this key gives you an option to specify +In addition to :ref:`key-url`, this key gives you an option to specify more than one URL to further relevant repositories. If you use the key, you need to specify the URL in the same way as is required for the key ``url``. You can specify more than one URL. From 7ab2b9ecdf731ab5f4242a01c9f4d123312fd1a7 Mon Sep 17 00:00:00 2001 From: Smart-City-Muenster <84011331+Smart-City-Muenster@users.noreply.github.com> Date: Tue, 15 Oct 2024 15:17:37 +0200 Subject: [PATCH 7/7] further specify what is a "component" --- docs/standard/schema.core.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index b02af999..fa76e7c2 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -74,9 +74,12 @@ Key ``components`` Some software projects are organized in more than one repository. In addition to :ref:`key-url`, this key gives you an option to specify -more than one URL to further relevant repositories. If you use the key, -you need to specify the URL in the same way as is required for the key ``url``. -You can specify more than one URL. +more than one URL to further repositories, that are essential parts of +the software (e.g. one repository for the frontend and another repository +for the backend). + +If you use the key, you need to specify the URL in the same way as +is required for the key ``url``. You can specify more than one URL. Key ``landingURL`` ~~~~~~~~~~~~~~~~~~