[
https://issues.jboss.org/browse/WFLY-9744?page=com.atlassian.jira.plugin....
]
Radoslav Husar updated WFLY-9744:
---------------------------------
Description:
In order to not duplicate documentation in docs/ and wildscribe, we will link from
documentation to wildscribe. This requires descriptions to be improved. The descriptions:
* should describe behavior
* should avoid using domain model terminology (e.g. attributes, child)
* take out the redundant verb such as 'configures' (unless appropriate, e.g. in
operation desc.)
* remove unnecessary "Deprecated." notices, the information is already in the
model, e.g.:
{noformat}
"deprecated" => {
"since" => "5.0.0",
"reason" => "Deprecated. Consider using a shared
store instead, where writes are only performed by primary owners."
},
{noformat}
Upon completion, we can remove the sections from documentation and link.
was:
In order to not duplicate documentation in docs/ and wildscribe, we will link from
documentation to wildscribe. This requires descriptions to be improved. The descriptions:
* should describe behavior
* should avoid using domain model terminology (e.g. attributes, child)
* take out the redundant verb such as 'configures' (unless appropriate, e.g. in
operation desc.)
Upon completion, we can remove the sections from documentation and link.
Improve Infinispan subsystem model descriptions
------------------------------------------------
Key: WFLY-9744
URL:
https://issues.jboss.org/browse/WFLY-9744
Project: WildFly
Issue Type: Task
Components: Clustering
Reporter: Radoslav Husar
Assignee: Paul Ferraro
In order to not duplicate documentation in docs/ and wildscribe, we will link from
documentation to wildscribe. This requires descriptions to be improved. The descriptions:
* should describe behavior
* should avoid using domain model terminology (e.g. attributes, child)
* take out the redundant verb such as 'configures' (unless appropriate, e.g. in
operation desc.)
* remove unnecessary "Deprecated." notices, the information is already in the
model, e.g.:
{noformat}
"deprecated" => {
"since" => "5.0.0",
"reason" => "Deprecated. Consider using a shared
store instead, where writes are only performed by primary owners."
},
{noformat}
Upon completion, we can remove the sections from documentation and link.
--
This message was sent by Atlassian JIRA
(v7.5.0#75005)