diff --git a/docs/standard/example/publiccode.yml b/docs/standard/example/publiccode.yml index 0441a28..3618928 100644 --- a/docs/standard/example/publiccode.yml +++ b/docs/standard/example/publiccode.yml @@ -3,6 +3,9 @@ publiccodeYmlVersion: "0.4" 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" diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index a563c36..fa76e7c 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`` ~~~~~~~~~~~ @@ -64,6 +66,21 @@ 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 :ref:`key-url`, this key gives you an option to specify +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`` ~~~~~~~~~~~~~~~~~~