Skip to content

Commit 7464845

Browse files
authored
fix: several typos, RST structure, new schema changes (#31)
fix: removed URI from iPA fix: modified contacts, fixes #29 and #30 fix: changed example to face new contacts dependency fix: moved ecosistemi out of riuso fix: changed nested level it schema feat: added example.rst in english fix: port the english version to match the italian one feat: new changes to schema description
1 parent 2b88528 commit 7464845

File tree

18 files changed

+379
-370
lines changed

18 files changed

+379
-370
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ _site
88

99
# Windows generic
1010
Thumbs.db
11+
12+
# Swap files
13+
*.swp

docs/en/example.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Esempi
2+
==========================
3+
4+
Below there are two examples of `publiccode.yml` files, the first one
5+
represents the minimum configuration, which contains the mandatory fields,
6+
whilst the second one represents a more extended version.
7+
8+
Minimum Version
9+
~~~~~~~~~~~~~~~
10+
11+
.. literalinclude:: example/publiccode.minimal.yml
12+
:language: yaml
13+
:linenos:
14+
15+
16+
Extended Version
17+
~~~~~~~~~~~~~~~
18+
19+
.. literalinclude:: example/publiccode.yml
20+
:language: yaml
21+
:linenos:
22+
23+
24+

docs/en/example/publiccode.yml

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ maintenance:
9191

9292
contractors:
9393
- name: "Fornitore Privato SPA"
94+
email: "dario.bianchi@fornitore.it"
9495
website: "https://privatecompany.com"
9596
until: "2019-01-01"
9697

@@ -100,16 +101,6 @@ maintenance:
100101
affiliation: Comune di Reggio Emilia
101102
phone: +39 231 13215112
102103

103-
- name: Dario Bianchi
104-
email: "dario.bianchi@fornitore.it"
105-
affiliation: Fornitore Privato S.P.A.
106-
phone: +39 16 24231322
107-
108-
- name: Giancarlo Verdi
109-
email: "dario.bianchi@fornitore.it"
110-
affiliation: Fornitore Privato S.P.A.
111-
phone: +39 16 24231322
112-
113104
localisation:
114105
localisationReady: yes
115106
availableLanguages:
@@ -157,4 +148,4 @@ it:
157148
seo: no
158149
ui: yes
159150
web: yes
160-
content: no
151+
content: no

docs/en/forks.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1+
.. _forks-and-variants:
2+
13
Forks and variants
24
==================
35

4-
This document describes how to best handle software forks in the context
5-
of updating ``publiccode.yml``. We define two different semantics that
6-
require different handling: technical forks and software variants.
6+
As already cited before, a fork may have two different forms based on the final
7+
aim. As such, in order to make it clear how to handle the
8+
`publiccode.yml` in both cases, below we define two different
9+
semantics: technical forks and software variants.
710

811
Technical forks (i.e. to publish patches)
912
-----------------------------------------

docs/en/index.rst

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,14 @@
1-
``publiccode.yml``
2-
==================
3-
4-
A PublicCode file written following this specification is guaranteed to
5-
remain compatible with all parsers implementing any 0.x release.
6-
7-
For more information on version numbering see
8-
`SemVer.org <https://semver.org/>`__.
9-
10-
Schema documentation
11-
--------------------
12-
13-
- `Schema <schema.md>`__
14-
- `Italian extension to the schema <schema.it.md>`__
15-
- `List of acceptable tags <tags.md>`__
16-
17-
Concepts and lexicon
18-
--------------------
19-
20-
- `How to work with forks and variants <forks.md>`__
21-
22-
Examples
23-
--------
24-
25-
- `Minimal Example <example/publiccode.minimal.yml>`__
26-
- `Full Example <example/publiccode.yml>`__
1+
The ``publiccode.yml`` Standard
2+
===============================
3+
.. toctree::
4+
:maxdepth: 2
5+
:numbered:
6+
7+
intro.rst
8+
schema.md
9+
schema.it.md
10+
forks.md
11+
pa-types.md
12+
tags.md
13+
tools.md
14+
example.rst

docs/en/pa-types.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _pa-types:
2+
13
Public administration types
24
===========================
35

0 commit comments

Comments
 (0)