Skip to content

doc: explain what indexers do with the format #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bfabio wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: explain what indexers do with the format #349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/standard/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,15 @@ discoverable and thus reusable by other entities.

By including a ``publiccode.yml`` file in the root of a repository, and
populating it with information about the software, technicians and civil
servants can evaluate it. Automatic indexing tools can also be built, since the
format is easily readable by both humans and machines.
servants can evaluate it.

The format is easily readable by both humans and machines, and
automatic indexing tools are built on top of it: national software
catalogs crawl the published files and build searchable sites.
Catalogs federate across countries, since they all read the same
format. The `core tools
<https://github.com/publiccodeyml/publiccode.yml#core-tools>`__
provide the reference implementations to build on.

``publiccode.yml`` is mandatory for all public software developed in Italy,
according to the national `guidelines
Expand Down