From 18b96ab18c3b370fe3829347cb24f3cd19312fbd Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Thu, 28 May 2026 08:46:25 +0200 Subject: [PATCH] docs(spec): remove deprecated keys Drop everything marked deprecated in v0 ahead of the 1.0 release: monochromeLogo, inputTypes, outputTypes, genericName, legal/repoOwner, legal/authorsFile, lowercase country codes and the YAML 1.1 allowance. See #304. --- docs/standard/country.rst | 5 +- docs/standard/forks.rst | 2 +- docs/standard/schema.core.rst | 99 ++--------------------------------- 3 files changed, 8 insertions(+), 98 deletions(-) diff --git a/docs/standard/country.rst b/docs/standard/country.rst index 898d5d97..4e7e3af0 100644 --- a/docs/standard/country.rst +++ b/docs/standard/country.rst @@ -7,9 +7,8 @@ Country-specific sections allow including information relevant only within a given country, such as compliance with national regulations or integration with national platforms. -Each section is identified by a two-letter ISO 3166-1 alpha-2 country code -lowercase (*deprecated*) or uppercase `ISO 3166-1 alpha-2 country -codes `__. +Each section is identified by an uppercase two-letter `ISO 3166-1 alpha-2 country +code `__. Currently, the only defined country-specific section is the Italian one (``IT:``). diff --git a/docs/standard/forks.rst b/docs/standard/forks.rst index f09fbc76..74d05b03 100644 --- a/docs/standard/forks.rst +++ b/docs/standard/forks.rst @@ -98,7 +98,7 @@ least: from which this variant is derived. - Change the value for ``url`` to point to the repository holding the variant. -- Change the value for ``legal/repoOwner`` to refer to themselves +- Change the value for ``organisation/name`` to refer to themselves (the authors of the variant). - Revisit the ``maintenance`` section to refer to the maintenance status of the variant. diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index 578d4cf4..0b5fc665 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -130,52 +130,6 @@ the repository, or it can be an absolute URL pointing to the logo in raw version. In both cases, the file must reside inside the same repository where the ``publiccode.yml`` file is stored. -Key ``monochromeLogo`` (*deprecated*) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Type: string (path to file) -- Presence: optional -- Acceptable formats: SVG, SVGZ, PNG -- Example: ``"img/logo-mono.svg"`` - -A monochromatic (black) logo. The logo should be in vector format; -raster formats are only allowed as a fallback. In this case, they should -be transparent PNGs, minimum 1000px of width. -The key value can be the relative path to the file starting from the root of -the repository, or it can be an absolute URL pointing to the logo in raw -version. In both cases, the file must reside inside the same repository where -the ``publiccode.yml`` file is stored. - -Key ``inputTypes`` (*deprecated*) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Type: array of enumerated strings -- Presence: optional -- Values: as per RFC 6838 -- Example: ``"text/plain"`` - -A list of Media Types (MIME Types) as mandated in `RFC -6838 `__ which the application can -handle as input. - -In case the software does not support any input, you can skip this field -or use ``application/x.empty``. - -Key ``outputTypes`` (*deprecated*) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Type: array of enumerated strings -- Presence: optional -- Values: as per RFC 6838 -- Example: ``"text/plain"`` - -A list of Media Types (MIME Types) as mandated in `RFC -6838 `__ which the application can -handle as output. - -In case the software does not support any output, you can skip this -field or use ``application/x.empty``. - Key ``platforms`` ~~~~~~~~~~~~~~~~~ @@ -345,8 +299,8 @@ Key ``intendedAudience/countries`` This key explicitly includes certain countries in the intended audience, i.e. the software explicitly claims compliance with specific processes, -technologies or laws. All countries are specified using lowercase (*deprecated*) -or uppercase ISO 3166-1 alpha-2 two-letter country codes. +technologies or laws. All countries are specified using uppercase +ISO 3166-1 alpha-2 two-letter country codes. Key ``intendedAudience/unsupportedCountries`` ''''''''''''''''''''''''''''''''''''''''''''' @@ -357,7 +311,7 @@ Key ``intendedAudience/unsupportedCountries`` This key explicitly marks countries as NOT supported. This might be the case if there is a conflict between how software is working and a specific law, process or technology. All countries are specified using -lowercase (*deprecated*) or uppercase ISO 3166-1 alpha-2 two-letter country codes. +uppercase ISO 3166-1 alpha-2 two-letter country codes. Key ``intendedAudience/scope`` '''''''''''''''''''''''''''''' @@ -412,19 +366,6 @@ name most people usually refer to the software. In case the software has both an internal “code” name and a commercial name, use the commercial name. -Key ``description/[lang]/genericName`` (*deprecated*) -''''''''''''''''''''''''''''''''''''''''''''''''''''' - -- Type: string (max 35 chars) -- Presence: optional -- Example: ``"Text Editor"`` - -This key is the “Generic name”, which refers to the specific category to -which the software belongs. You can usually find the generic name in the -presentation of the software, when you write: “Software xxx is a yyy”. -Notable examples include “Text Editor”, “Word Processor”, “Web Browser”, -“Chat” and so on… The generic name can be up to 35 characters long. - Key ``description/[lang]/shortDescription`` ''''''''''''''''''''''''''''''''''''''''''' @@ -603,36 +544,7 @@ sentence. It is also possible to informally refer to a community of group of people like “Linus Torvalds and all Linux contributors”. In case it is not possible to name a main copyright owner, it is -possible to omit this key; in those cases, if the repo has a authors -file, you can point to it through ``legal/authorsFile``. - -Key ``legal/repoOwner`` (*deprecated*) -'''''''''''''''''''''''''''''''''''''' - -- Type: string -- Presence: optional -- Example: ``"City of Amsterdam"`` - -This string describes the entity that owns this repository; this might -or might not be the same entity who owns the copyright on the code -itself. For instance, in case of a fork of the original software, the -``repoOwner`` is probably different from the ``mainCopyrightOwner``. - -This key is deprecated, use ``organisation/name`` instead. - -Key ``legal/authorsFile`` (*deprecated*) -'''''''''''''''''''''''''''''''''''''''' - -- Type: string (path to file) -- Presence: optional -- Example: ``"doc/AUTHORS.txt"`` - -Some open-source software adopt a convention of identify the copyright -holders through a file that lists all the entities that own the -copyright. This is common in projects strongly backed by a community -where there are many external contributors and no clear single/main -copyright owner. In such cases, this key can be used to refer to the -authors file, using a path relative to the root of the repository. +possible to omit this key. Section ``maintenance`` ~~~~~~~~~~~~~~~~~~~~~~~ @@ -861,5 +773,4 @@ format though, so not the full ISO8601 is allowed for the date keys. Encoding ~~~~~~~~ -`publiccode.yml` **MUST** be a UTF-8 encoded and **SHOULD** be a YAML 1.2 document, -using YAML 1.1 is *deprecated*. +`publiccode.yml` **MUST** be a UTF-8 encoded and **MUST** be a YAML 1.2 document.