accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Eric Newton (Commented) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-123) Dynamically generate configuration documentation
Date Thu, 10 Nov 2011 22:25:51 GMT

    [ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13148055#comment-13148055
] 

Eric Newton commented on ACCUMULO-123:
--------------------------------------

Another benefit of the web page is that we can show the current values *right now* like we
do in the shell.  I would rather have an accumulo-site.xml.defaults file that contains documented
attribute-value pairs that I can consult with a text editor (copy-n-paste) to produce my first
config file.  This would be handy when I need to create a second instance on a cluster and
need to change 5 port number settings.  We just need the accumulo-site.xml.defaults to be
generated properly by an accumulo-build project that depends on accumulo-core.

                
> Dynamically generate configuration documentation
> ------------------------------------------------
>
>                 Key: ACCUMULO-123
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-123
>             Project: Accumulo
>          Issue Type: Improvement
>            Reporter: Keith Turner
>            Assignee: John Vines
>             Fix For: 1.4.0
>
>
> The configuration documentation page is generated as a static html page at build time.
 There are a few drawbacks to this:
>  
>  * If the build process fails, it will generate an incorrect page.  Currently I think
the build process only works correctly if the maven scripts are run twice.
>  * If someone changes the configuration names or defaults in the code, but forgets to
check in the updated html page then its out of sync.
> It would be better if the monitor just generated the page dynamically.  The documentation
html page could link to a servlet in the monitor.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message