Bug 1164688 - Provide documentation which describes information of whole configuration parameters for JDG
Summary: Provide documentation which describes information of whole configuration para...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Data Grid 6
Classification: JBoss
Component: Documentation
Version: 6.3.1
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: CR3
: 6.4.0
Assignee: Misha H. Ali
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks: jdg64-GA-Blockers
TreeView+ depends on / blocked
 
Reported: 2014-11-17 07:21 UTC by Masafumi Miura
Modified: 2018-12-09 19:11 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-01-27 23:44:08 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker ISPN-4769 0 Major Resolved XSD documentation generator does not handle some types (e.g. xs:list) 2016-06-22 02:43:52 UTC
Red Hat Issue Tracker ISPN-4770 0 Major Resolved PublicAPI doclet crashes when generics without type parameters are found 2016-06-22 02:43:52 UTC
Red Hat Issue Tracker ISPN-4771 0 Major Resolved Combine doclets to avoid running javadocs multiple times 2016-06-22 02:43:52 UTC

Description Masafumi Miura 2014-11-17 07:21:32 UTC
### Document URL: 

N/A

### Section Number and Name: 

N/A

### Describe the issue/Suggestions for improvement: 

Please provide documentation which describes information of whole configuration parameters for JDG, which is similar to https://docs.jboss.org/infinispan/6.0/configdocs/ for the community versions of infinispan.

Please note that the above community documentation contains some unsupported configuration parameters in JDG (for example, Capacity Factor).

### Additional information: 

It appears that https://docs.jboss.org/infinispan/6.0/configdocs/ is generated from "docs/schema/infinispan-*.xsd". However, $JDG_HOME/docs/schema/infinispan-*.xsd contains some unsupported configuration parameters in JDG (for example, Capacity Factor). Please state "unsupported in JDG" explicitly or remove such unsupported parameters from schema files.

Comment 2 Misha H. Ali 2014-11-26 03:38:36 UTC
Emailed Tristan and David about using whatever we are using for ISPN xsd -> html conversion on JDG schemas as well.

Comment 5 Tristan Tarrant 2015-01-07 13:37:55 UTC
Misha this was done because some code changes needed to be performed so that the HTML version of the schema could be generated properly

Comment 9 Misha H. Ali 2015-01-21 05:13:59 UTC
Hi guys,

To reclarify, this bug is for docs, and we are tracking including the payload in the docs (probably within the API Documentation wrapper). We can duplicate it and assign the clone to David if dev wants to track their generation and inclusion and testing of this for their own docs.

Comment 12 Martin Gencur 2015-01-26 09:55:57 UTC
Looks good to me.


Note You need to log in before you can comment on or make changes to this bug.