publiccodeyml · libremente · Jan 21, 2019 · Jan 17, 2019 · Jan 17, 2019 · Jan 17, 2019
diff --git a/.travis.yml b/.travis.yml
diff --git a/Dockerfile b/Dockerfile
diff --git a/Gemfile b/Gemfile
diff --git a/README.md b/README.md
@@ -1,14 +1,15 @@
 # The `publiccode.yml` standard
 
-
 ![Repo Status: Alpha](https://img.shields.io/badge/status-alpha-lightgrey.svg?longCache=true&style=plastic)
-[![Build status](https://travis-ci.com/italia/publiccode.yml.svg?branch=master)](https://travis-ci.com/italia/publiccode.yml)
 
-A metadata description standard for public software and policy repositories that is easy to use both for developers and less technical people in order to make the software developed by public administrations and public organisations easily discoverable.
+A metadata description standard for public software and policy repositories
+that is easy to use both for developers and people with less technical
+background, in order to make the software developed by Public Administrations
+and Public Organisations easily discoverable.
 
-**Latest release:  [Version 0.1](version/0.1)**
+**Latest release:  [Version 0.1](https://github.com/italia/publiccode.yml/releases/latest)**
 
-[See all versions](version)
+[See all versions](https://github.com/italia/publiccode.yml/releases)
 
 This project follows the Semantic Versioning.
 
@@ -18,40 +19,46 @@ The PublicCode specification is developed by the [Italian Digital Transformation
 
 ## What this file is for
 
-Many great software projects are developed by public administrations, however reuse of these projects is very limited. Some of the reasons for low uptake of these projects is a lack of discoverability and that it is hard to find out what project can actually work in the context of a different public administration.
-
-The `publiccode.yml` file is meant to solve these problems. It is an easily readable file for civil servants that are trying to figure out whether a project will work for them, and easily readable for computers. It contains information such as:
-
-* The title and description of the project or product in English and/or other languages
-* The status of development, e.g. `concept`, `development`, `beta`, `stable`, `obsolete`
-* By what organisation this project is developed
-* Who is caring for the maintenance and when this runs out
-* Who to contact for technical or support inquiries
-* What national and local legal frameworks this project or product works in
-* What software dependencies this project or product has
-
-The format should both be able to easily be added to any new project, as well as grow with the project as it grows beyond the original context it was developed in.
+Many great software projects are developed by public administrations, however
+reuse of these projects is very limited. Some of the reasons for low uptake of
+such projects is a lack of discoverability and that it is hard to find out
+what project can actually work in the context of a different public
+administration.
+
+The `publiccode.yml` file is meant to solve all those problems. As such, it is an easily
+readable file for civil servants that are trying to figure out whether
+a project will work for them, and easily readable for computers as well. It contains
+information such as:
+
+* the title and description of the project or product in English and/or other languages;
+* the development status, e.g. `concept`, `development`, `beta`, `stable`, `obsolete`;
+* which organisation developed the project;
+* who is caring for the maintenance and when this expires; 
+* who to contact for technical or support inquiries;
+* what national and local legal frameworks this project or product is designed
+  for;
+* what software dependencies this project or product has. 
+
+The `publiccode.yml` file format should both be able to easily be added to any
+new project, as well as grow with the project as it expands beyond the original
+context it was developed in.
 
 ## Finding projects
 
-Finding projects depends on how the search API is structured for every hosting platform. For example, you can find all `publiccode.yml` on GitHub files by searching using the frontend or the API.
+Finding projects depends on how the search API is structured for every hosting
+platform. For example, you can find all `publiccode.yml` on GitHub files by
+searching using the frontend or the API.
 
-* [GitHub Search `filename:publiccode.yml`](https://github.com/search?utf8=%E2%9C%93&q=filename%3Apubliccode.yml&type=)
+* [GitHub Search `filename:publiccode.yml path:/`](https://github.com/search?q=filename%3Apubliccode.yml+path%3A%2F)
 
-The Italian Digital Transformation Team is also working on providing a scanner which looks for all PublicCode files on all publicly accessible websites, and exposing them as open data.
-
-## Live editor / Demo
-
-You can find a live instance of the editor [here](http://publiccode.surge.sh/)
+The Italian Digital Transformation Team is also working on providing a scanner
+which looks for all publiccode files on all publicly accessible websites, and
+exposing them as open data.
 
 ## Contributing
 
 Feel free to submit [Pull Requests and to file Issues](CONTRIBUTING.md).
 
-## Website
-
-The website at <https://w3id.org/publiccode/> is automatically generated from the `master` branch of the [`publiccode.yml` repository](https://github.com/italia/publiccode.yml) using [GitHub pages](https://pages.github.com) and its static site generator [Jekyll](https://jekyllrb.com).
-
 ## Licence
 
 Licenced under the [CC-0](LICENSE)
diff --git a/_config.yml b/_config.yml
diff --git a/docker-compose.yml b/docker-compose.yml
diff --git a/version/0.1/example/publiccode.minimal.yml → docs/en/example/publiccode.minimal.yml b/version/0.1/example/publiccode.minimal.yml → docs/en/example/publiccode.minimal.yml
diff --git a/version/0.1/example/publiccode.yml → docs/en/example/publiccode.yml b/version/0.1/example/publiccode.yml → docs/en/example/publiccode.yml
diff --git a/version/0.1/forks.md → docs/en/forks.md b/version/0.1/forks.md → docs/en/forks.md
diff --git a/version/0.1/index.md → docs/en/index.md b/version/0.1/index.md → docs/en/index.md
diff --git a/version/0.1/pa-types.md → docs/en/pa-types.md b/version/0.1/pa-types.md → docs/en/pa-types.md
diff --git a/docs/en/schema.it.md b/docs/en/schema.it.md
@@ -0,0 +1,2 @@
+Placeholder for [schema.it.md](../it/schama.it.md).
+
diff --git a/version/0.1/schema.md → docs/en/schema.md b/version/0.1/schema.md → docs/en/schema.md
diff --git a/version/0.1/tags.md → docs/en/tags.md b/version/0.1/tags.md → docs/en/tags.md
diff --git a/...evelopment/example/publiccode.minimal.yml → docs/it/example/publiccode.minimal.yml b/...evelopment/example/publiccode.minimal.yml → docs/it/example/publiccode.minimal.yml
@@ -1,12 +1,29 @@
+### publiccode.minimal.yml
+#
+# This is a minimal example, i.e. it only contains values for the keys which
+# are specified as mandatory in the specification
+#
+# All the documentation for the schema is accessible at the URL
+#   http://w3id.org/publiccode/version/0.1
+
 publiccode-yaml-version: "http://w3id.org/publiccode/version/0.1"
 
 name: Medusa
 url: "https://example.com/italia/medusa.git"
 softwareVersion: "dev"
 releaseDate: "2017-04-15"
+
+# You can use any string, but it's better if you stick to
+# values suggested:
+# http://yml.publiccode.net/version/0.1/schema.html#key-platforms
 platforms:
   - web
 
+# Allowed values are accessible here:
+# http://w3id.org/publiccode/version/0.1/tags.html
+#
+# Only stick to these tags! If you need additional tags (localised),
+# you have the chance of adding them under the description/freeTags key
 tags:
   - texteditor
 
@@ -15,6 +32,7 @@ developmentStatus: development
 softwareType: "standalone"
 
 description:
+  ## This example uses English: you can use any language you want
   eng:
     localisedName: Medusa
     genericName: Text Editor
@@ -32,6 +50,7 @@ description:
        - Just one feature
 
 legal:
+  # The license is an SPDX expression, and may not be a single license
   license: AGPL-3.0-or-later
 
 maintenance:

diff --git a/version/development/example/publiccode.yml → docs/it/example/publiccode.yml b/version/development/example/publiccode.yml → docs/it/example/publiccode.yml
@@ -1,4 +1,12 @@
-publiccodeYamlVersion: "http://w3id.org/publiccode/version/0.2"
+### publiccode.minimal.yml
+#
+# This is a full example of a publiccode.yml file, i.e. it tries to include
+# a meaningul value for all keys specified in the documentation.
+#
+# Full documentation for the schema is accessible at the URL
+#   http://w3id.org/publiccode/version/0.1
+
+publiccode-yaml-version: "http://w3id.org/publiccode/version/0.1"
 
 name: Medusa
 applicationSuite: MegaProductivitySuite
@@ -21,6 +29,9 @@ platforms:
   - ios
 
 # For a list of allowed values, check out w3id.org/publiccode/version/0.1/tags.html
+#
+# Only stick to these tags! If you need additional tags (localised),
+# you have the chance of adding them under the description/freeTags key
 tags:
   - content-management
   - artificial-intelligence
@@ -92,7 +103,7 @@ maintenance:
 
   contractors:
     - name: "Fornitore Privato SPA"
-      url: "https://privatecompany.com"
+      website: "https://privatecompany.com"
       until: "2019-01-01"
 
   contacts:

diff --git a/docs/it/forks.md b/docs/it/forks.md
@@ -0,0 +1,3 @@
+Placeholder per [forks.md](../en/forks.md)
+
+
diff --git a/docs/it/index.md b/docs/it/index.md
@@ -0,0 +1,3 @@
+Placeholder per [index.md](../en/index.md)
+
+
diff --git a/docs/it/pa-types.md b/docs/it/pa-types.md
@@ -0,0 +1,3 @@
+Placeholder per [pa-types.md](../en/pa-types.md)
+
+
diff --git a/version/0.1/schema.it.md → docs/it/schema.it.md b/version/0.1/schema.it.md → docs/it/schema.it.md
diff --git a/docs/it/schema.md b/docs/it/schema.md
@@ -0,0 +1,3 @@
+Placeholder per [schema.md](../en/schema.md)
+
+
diff --git a/docs/it/tags.md b/docs/it/tags.md
@@ -0,0 +1,3 @@
+Placeholder per [tags.md](../en/tags.md)
+
+
diff --git a/editor/.babelrc b/editor/.babelrc
diff --git a/editor/.eslintrc b/editor/.eslintrc
diff --git a/editor/.gitignore b/editor/.gitignore
diff --git a/editor/CNAME b/editor/CNAME
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Placeholder for [schema.it.md](../it/schama.it.md).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Placeholder per [pa-types.md](../en/pa-types.md)