Commit 53b42952 authored by Guido Gunther's avatar Guido Gunther

Move doap example to separate file

This makes it easier to edit, reeuse and valiate. The ":language: XML"
ensures syntax highlighting.
parent cc4ee15b
......@@ -12,37 +12,10 @@ If you wish to own an issue, you will need additional permissions in our GitLab
Repository Guidelines
*********************
If you have a repository that you maintain but expect others to contribute to, then it is helpful for newcomers to know who to contact when they have questions regarding that repository. For this reason, we would like every repository to contain a `doap <https://en.wikipedia.org/wiki/DOAP>`_ file with the maintaner field filled out. Optionally, if you know of someone that will regularly review your merge requests, then the helper field should also be completed. For a list of supported doap fields, see `this list on Wikipedia <https://en.wikipedia.org/wiki/DOAP>`_ but below is complete example you can modify to match your project::
<?xml version="1.0" encoding="UTF-8"?>
<Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:foaf="http://xmlns.com/foaf/0.1/"
xmlns:gnome="http://api.gnome.org/doap-extensions#"
xmlns="http://usefulinc.com/ns/doap#">
<name>YOUR PROJECT</name>
<shortname>YOUR PROJECT</shortname>
<shortdesc>DESCRIPTION OF YOUR PROJECT</shortdesc>
<homepage rdf:resource="LINK TO CODE" />
<license rdf:resource="http://usefulinc.com/doap/licenses/gpl" />
<programming-language>LANG</programming-language>
<maintainer>
<foaf:Person>
<foaf:name>MAINTAINER'S NAME</foaf:name>
<foaf:mbox rdf:resource="mailto:MAINTAINER'S EMAIL" />
</foaf:Person>
</maintainer>
<helper>
<foaf:Person>
<foaf:name>FREQUENT REVIEWER NAME</foaf:name>
<foaf:mbox rdf:resource="mailto:FREQUENT REVIEWER EMAIL" />
</foaf:Person>
</helper>
</Project>
If you have a repository that you maintain but expect others to contribute to, then it is helpful for newcomers to know who to contact when they have questions regarding that repository. For this reason, we would like every repository to contain a `doap <https://en.wikipedia.org/wiki/DOAP>`_ file with the maintaner field filled out. Optionally, if you know of someone that will regularly review your merge requests, then the helper field should also be completed. For a list of supported doap fields, see `this list on Wikipedia <https://en.wikipedia.org/wiki/DOAP>`_ but below is complete example you can modify to match your project:
.. literalinclude:: examples/doap.xml
:language: XML
Be sure to adapt the above template to match your project info.
......
<?xml version="1.0" encoding="UTF-8"?>
<Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:foaf="http://xmlns.com/foaf/0.1/"
xmlns:gnome="http://api.gnome.org/doap-extensions#"
xmlns="http://usefulinc.com/ns/doap#">
<name>YOUR PROJECT</name>
<shortname>YOUR PROJECT</shortname>
<shortdesc>DESCRIPTION OF YOUR PROJECT</shortdesc>
<homepage rdf:resource="LINK TO CODE" />
<license rdf:resource="http://usefulinc.com/doap/licenses/gpl" />
<programming-language>LANG</programming-language>
<maintainer>
<foaf:Person>
<foaf:name>MAINTAINER'S NAME</foaf:name>
<foaf:mbox rdf:resource="mailto:MAINTAINER'S EMAIL" />
</foaf:Person>
</maintainer>
<helper>
<foaf:Person>
<foaf:name>FREQUENT REVIEWER NAME</foaf:name>
<foaf:mbox rdf:resource="mailto:FREQUENT REVIEWER EMAIL" />
</foaf:Person>
</helper>
</Project>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment