Skip to content

Commit 879614e

Browse files
authored
doc(standard): make categories optional and add other (#241)
The list of categories have always being a problem, stuck between: * keeping the list short and curated, which excludes legit use cases and annoys authors * making it huge and comprehensive, which turns it into a mess nobody can navigate * maintaining it manually, which is slow, political, and opaque * avoiding local categorizations (probably a good call), but ending up with a list that feels incomplete Make them optional, so if people feel they fit in their usecase they can opt in, otherwise they can ignore them or user `other`. Fix #217.
1 parent 2f23c45 commit 879614e

13 files changed

Lines changed: 49 additions & 60 deletions

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ name: My text editor
6464
url: "https://example.com/mysoftware/text-editor.git"
6565
platforms:
6666
- windows
67-
categories:
68-
- office
6967
developmentStatus: development
7068
softwareType: standalone/desktop
7169
description:

docs/de/Example.de.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@ Minimal-Konfiguration
1515
platforms:
1616
- web
1717
18-
categories:
19-
- financial-reporting
20-
2118
developmentStatus: development
2219
2320
softwareType: "standalone/desktop"

docs/de/categories-list.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Liste von Software-Kategorien
22
=============================
3-
Es folgt ein festgelegtes Verzeichnis mit nützlichen Tags zur Kategorisierung der Software.
3+
Es folgt ein festgelegtes Verzeichnis gültiger Kategorien für die Software.
44

5-
Gültige Tags
6-
------------
5+
Gültige Kategorien
6+
------------------
77

88
- accounting
99

@@ -210,3 +210,5 @@ Gültige Tags
210210
- website-builder
211211

212212
- workflow-management
213+
214+
- other

docs/de/schema.core.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,10 @@ Key ``categories``
198198
~~~~~~~~~~~~~~~~~~
199199

200200
- Type: array of strings
201-
- Presence: mandatory
201+
- Presence: optional
202202
- Acceptable values: see :ref:`categories-list`
203203

204-
A list of words that can be used to describe the software and can help
204+
A list of categories that can be used to describe the software and can help
205205
building catalogs of open software.
206206

207207
The controlled vocabulary :ref:`categories-list` contains the list of allowed

docs/fr/categories-list.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
Liste des catégories de logiciel
44
===========================
55

6-
Ici se trouve une liste contrôlée du vocabulaire des tags utiles pour catégoriser un logiciel.
6+
Ici se trouve une liste contrôlée du vocabulaire des catégories pour le logiciel.
77

8-
==========
9-
Tags valides
10-
==========
8+
==================
9+
Catégories valides
10+
==================
1111

1212
- accounting
1313
- agile-project-management
@@ -113,3 +113,4 @@ Tags valides
113113
- website-builder
114114
- whistleblowing
115115
- workflow-management
116+
- other

docs/fr/example/publiccode.minimal.yml

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,24 @@ url: "https://example.com/italia/medusa.git"
55
platforms:
66
- web
77

8-
categories:
9-
- financial-reporting
10-
118
developmentStatus: development
129

1310
softwareType: "standalone/desktop"
1411

1512
description:
1613
en:
1714
shortDescription: >
18-
A rather short description which
19-
is probably useless
15+
A rather short description which
16+
is probably useless
2017
2118
longDescription: >
22-
Very long description of this software, also split
23-
on multiple rows. You should note what the software
24-
is and why one should need it. We can potentially
25-
have many pages of text here.
19+
Very long description of this software, also split
20+
on multiple rows. You should note what the software
21+
is and why one should need it. We can potentially
22+
have many pages of text here.
2623
2724
features:
28-
- Just one feature
25+
- Just one feature
2926

3027
legal:
3128
license: AGPL-3.0-or-later

docs/fr/schema.core.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,10 +205,10 @@ Clé ``categories``
205205
~~~~~~~~~~~~~~~~~~
206206

207207
- Type: array de chaînes de caractères
208-
- Présence: obligatoire
208+
- Présence: facultative
209209
- Valeurs acceptées: voir :ref:`categories-list`
210210

211-
Une liste des mots qui peuvent être utilisés pour décrire le logiciel
211+
Une liste des categories qui peuvent être utilisés pour décrire le logiciel
212212
et aider à la constitution d'un catalogue des logiciels ouverts.
213213

214214
Le vocabulaire contrôlé de la :ref:`categories-list` présente la liste

docs/it/categories-list.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
Lista delle categorie di software
44
=================================
55

6-
Qui di seguito è presentato un vocabolario controllato di tag utilizzabili
7-
per categorizzare il software.
6+
Qui di seguito è presentato un vocabolario controllato delle categorie utilizzabili.
87

9-
==========
10-
Tag Validi
11-
==========
8+
================
9+
Categorie valide
10+
================
1211
- accounting
1312
- agile-project-management
1413
- applicant-tracking
@@ -114,3 +113,4 @@ Tag Validi
114113
- website-builder
115114
- whistleblowing
116115
- workflow-management
116+
- other

docs/it/example/publiccode.minimal.yml

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,24 @@ url: "https://example.com/italia/medusa.git"
55
platforms:
66
- web
77

8-
categories:
9-
- financial-reporting
10-
118
developmentStatus: development
129

1310
softwareType: "standalone/desktop"
1411

1512
description:
1613
en:
1714
shortDescription: >
18-
A rather short description which
19-
is probably useless
15+
A rather short description which
16+
is probably useless
2017
2118
longDescription: >
22-
Very long description of this software, also split
23-
on multiple rows. You should note what the software
24-
is and why one should need it. We can potentially
25-
have many pages of text here.
19+
Very long description of this software, also split
20+
on multiple rows. You should note what the software
21+
is and why one should need it. We can potentially
22+
have many pages of text here.
2623
2724
features:
28-
- Just one feature
25+
- Just one feature
2926

3027
legal:
3128
license: AGPL-3.0-or-later

docs/it/schema.core.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,10 @@ Chiave ``categories``
212212
~~~~~~~~~~~~~~~~~~~~~
213213

214214
- Tipo: array di stringhe
215-
- Presenza: obbligatoria
215+
- Presenza: opzionale
216216
- Valori accettabili: vedi :ref:`categories-list`
217217

218-
Una lista di parole che possono essere usate per descrivere il software
218+
Una lista di categorie che possono essere usate per descrivere il software
219219
e possono aiutare a costruire il catalogo di software open.
220220

221221
Il vocabolario controllato :ref:`categories-list` presenta la lista dei valori

0 commit comments

Comments
 (0)