You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geronimo.apache.org by "Rakesh Midha (JIRA)" <ji...@apache.org> on 2006/12/14 07:52:21 UTC
[jira] Created: (GERONIMO-2661) Make geronimo schema files more
human readable
Make geronimo schema files more human readable
----------------------------------------------
Key: GERONIMO-2661
URL: http://issues.apache.org/jira/browse/GERONIMO-2661
Project: Geronimo
Issue Type: Improvement
Security Level: public (Regular issues)
Components: documentation
Affects Versions: 2.0
Environment: Any
Reporter: Rakesh Midha
Fix For: 2.0
Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
Schema formatting provides a nice option to do this by specifying
<xs:annotation>
<xs:documentation lang="en">documentation for each element goes here</xs:documentation>
</xs:annotation>
for each and every element in schema files.
I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Assigned: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Matt Hogstrom (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Matt Hogstrom reassigned GERONIMO-2661:
---------------------------------------
Assignee: Matt Hogstrom
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Matt Hogstrom
> Priority: Minor
> Fix For: 2.0
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: moduledoc.patch
logindoc.patch
jettydoc.patch
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: jettyconfigdoc.patch
connectordoc.patch
attributedoc.patch
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Assigned: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Christopher M. Cardona (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Christopher M. Cardona reassigned GERONIMO-2661:
------------------------------------------------
Assignee: Christopher M. Cardona (was: Matt Hogstrom)
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Christopher M. Cardona
> Priority: Minor
> Fix For: 2.0
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: moduledoc.patch
logindoc.patch
jettydoc.patch
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Closed: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Christopher M. Cardona (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Christopher M. Cardona closed GERONIMO-2661.
--------------------------------------------
Resolution: Fixed
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0-M5
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Christopher M. Cardona
> Priority: Minor
> Fix For: 2.0-M5
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/GERONIMO-2661?page=comments#action_12459191 ]
Rakesh Midha commented on GERONIMO-2661:
----------------------------------------
Thanks for replying Matt.
Sure, I will work on it and provide the required comments, I think it is important.
I am keeping it in wishlist for now, because it may take some time. For now I am just assigning this JIRA to myself. As soon as I am in some shape I will move it to 2.0.
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: http://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Matt Hogstrom (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12470808 ]
Matt Hogstrom commented on GERONIMO-2661:
-----------------------------------------
Rakesh...looks like you've been quite busy. I'll take a look through the patches and give them a go. Looks good from my quick peek. Thanks!
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Matt Hogstrom
> Priority: Minor
> Fix For: 2.0
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: securitydoc.patch
plugindoc.patch
namingdoc.patch
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: (was: moduledoc.patch)
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12484322 ]
Rakesh Midha commented on GERONIMO-2661:
----------------------------------------
Thanks Christopher
I can start my work on 2660 now. I hope that too makes sense.
Thanks
Rakesh
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0-M5
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Christopher M. Cardona
> Priority: Minor
> Fix For: 2.0-M5
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/GERONIMO-2661?page=all ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Description:
Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
Schema formatting provides a nice option to do this by specifying
<xs:annotation>
<xs:documentation lang="en">documentation for each element goes here</xs:documentation>
</xs:annotation>
for each and every element in schema files.
I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
was:
Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
Schema formatting provides a nice option to do this by specifying
<xs:annotation>
<xs:documentation lang="en">documentation for each element goes here</xs:documentation>
</xs:annotation>
for each and every element in schema files.
I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
Priority: Minor (was: Major)
Its not essential but if required, so changing the priority to minor. Will work on it when have some time.
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: http://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Priority: Minor
> Fix For: 2.0
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: (was: jettydoc.patch)
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Patch Info: [Patch Available]
Fix Version/s: (was: Wish List)
2.0
Assignee: (was: Rakesh Midha)
Marking patch available
unassigning so that someone can review and commit
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Priority: Minor
> Fix For: 2.0
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Christopher M. Cardona (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12475701 ]
Christopher M. Cardona commented on GERONIMO-2661:
--------------------------------------------------
Applied the alldoc.patch to trunk rev. 511458 with additional modifications:
- Removed the extra Apache license annotation (I think the original Apache license header is enough)
- Arranged the schema formatting
- Changed some annotation/documentation text
Thanks Rakesh!
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Christopher M. Cardona
> Priority: Minor
> Fix For: 2.0
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Assigned: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/GERONIMO-2661?page=all ]
Rakesh Midha reassigned GERONIMO-2661:
--------------------------------------
Assignee: Rakesh Midha
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: http://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Matt Hogstrom (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/GERONIMO-2661?page=all ]
Matt Hogstrom updated GERONIMO-2661:
------------------------------------
Fix Version/s: Wish List
(was: 2.0)
Rakesh...this would be awesome. The comments are specifically missing as the content in the Sun XSDs are copyrighted information. If you would like to add similar comments that would be great. Bear in mind that you cannot copy what Sun has done but you can phrase in your own words what each of the various elements are.
I'm moving this to wishlist. If you are interested in working on this please feel free to move this back to 2.0.
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: http://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12470565 ]
Rakesh Midha commented on GERONIMO-2661:
----------------------------------------
Attached is the patch for improved documentation for all the schema files.
You can either use alldoc.patch which contains all the updated schema files or use individual patch for seperate schems (eg use appdoc.patch for application schema and appclientdoc.patch for app client schema)
Please note :
1. All the schema as license included as header as well as annotation, the reason if some viewers shows the license if it is included as annotation (this is required if schema is exposed through documentation produced by such viewers)
2. I tried to add documentation for all the attributes and elements, if required it can be changed or improved
Please review and commit
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: 2.0
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: (was: logindoc.patch)
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: appdoc.patch
appclientdoc.patch
alldoc.patch
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (GERONIMO-2661) Make geronimo schema files more
human readable
Posted by "Rakesh Midha (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: webdoc.patch
tomcatdoc.patch
tomcatconfigdoc.patch
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.