You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@accumulo.apache.org by "Keith Turner (Updated) (JIRA)" <ji...@apache.org> on 2011/11/07 19:56:53 UTC
[jira] [Updated] (ACCUMULO-123) Dynamically generate configuration
documentation
[ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Keith Turner updated ACCUMULO-123:
----------------------------------
Description:
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.
was:
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 than 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.
> 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