Update schema and add docs for support
parent
c694bd57a3
commit
8c16c1bbef
|
@ -200,6 +200,30 @@ An example:
|
||||||
|
|
||||||
Optional, but highly recommended.
|
Optional, but highly recommended.
|
||||||
|
|
||||||
|
### support
|
||||||
|
|
||||||
|
Various information to get support about the project.
|
||||||
|
|
||||||
|
Support information includes the following:
|
||||||
|
|
||||||
|
* **email:** Email address for support.
|
||||||
|
* **issues:** URL to the Issue Tracker.
|
||||||
|
* **forum:** URL to the Forum.
|
||||||
|
* **wiki:** URL to the Wiki.
|
||||||
|
* **irc:** IRC channel for support, as irc://server/channel.
|
||||||
|
* **source:** URL to browse or download the sources.
|
||||||
|
|
||||||
|
An example:
|
||||||
|
|
||||||
|
{
|
||||||
|
"support": {
|
||||||
|
"email": "support@example.org",
|
||||||
|
"irc": "irc://irc.freenode.org/composer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Optional.
|
||||||
|
|
||||||
### Package links
|
### Package links
|
||||||
|
|
||||||
All of the following take an object which maps package names to
|
All of the following take an object which maps package names to
|
||||||
|
|
|
@ -209,11 +209,10 @@
|
||||||
},
|
},
|
||||||
"support": {
|
"support": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": true,
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"email": {
|
"email": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Email address of the community.",
|
"description": "Email address for support.",
|
||||||
"format": "email"
|
"format": "email"
|
||||||
},
|
},
|
||||||
"issues": {
|
"issues": {
|
||||||
|
@ -233,15 +232,15 @@
|
||||||
},
|
},
|
||||||
"irc": {
|
"irc": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Irc support channel"
|
"description": "IRC channel for support, as irc://server/channel.",
|
||||||
|
"format": "uri"
|
||||||
},
|
},
|
||||||
"source": {
|
"source": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "URL to the sources",
|
"description": "URL to browse or download the sources.",
|
||||||
"format": "uri"
|
"format": "uri"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue