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 (Created) (JIRA)" <ji...@apache.org> on 2011/11/07 19:56:53 UTC
[jira] [Created] (ACCUMULO-123) Dynamically generate configuration
documentation
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 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.
--
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
[jira] [Commented] (ACCUMULO-123) Dynamically generate
configuration documentation
Posted by "Keith Turner (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13148069#comment-13148069 ]
Keith Turner commented on ACCUMULO-123:
---------------------------------------
I like the idea of an accumulo-site.xml.defaults file for reference from the command line and for copying.
> 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
[jira] [Work stopped] (ACCUMULO-123) Dynamically generate
configuration documentation
Posted by "John Vines (Work stopped) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Work on ACCUMULO-123 stopped by John Vines.
> 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
[jira] [Commented] (ACCUMULO-123) Dynamically generate
configuration documentation
Posted by "Billie Rinaldi (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13147982#comment-13147982 ]
Billie Rinaldi commented on ACCUMULO-123:
-----------------------------------------
A problem with a dynamically generated page is that users will not be able to view the page without a running instance of Accumulo. Sometimes you want to look at the configuration parameters while you're configuring your Accumulo instance, before starting it up.
> 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
[jira] [Commented] (ACCUMULO-123) Dynamically generate
configuration documentation
Posted by "Keith Turner (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13148045#comment-13148045 ]
Keith Turner commented on ACCUMULO-123:
---------------------------------------
We could generate the static docs as part of the build process and have the monitor page dynamically generate the docs. The problem w/ this is that if there is a problem w/ the staticly generated docs its not likely that anyone would notice.
Another alternative is put a file in the docs directory that tells you how to generate the docs.
> 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
[jira] [Commented] (ACCUMULO-123) Dynamically generate
configuration documentation
Posted by "Eric Newton (Commented) (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Updated] (ACCUMULO-123) Dynamically generate configuration
documentation
Posted by "Keith Turner (Updated) (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Resolved] (ACCUMULO-123) Dynamically generate configuration
documentation
Posted by "John Vines (Resolved) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
John Vines resolved ACCUMULO-123.
---------------------------------
Resolution: Fixed
The build process now makes as little assumptions for generating the config.html page as possible. All other ideas for the monitor page should go to ACCUMULO-196, which is providing more functionality to 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
> Priority: Minor
> Fix For: 1.5.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
[jira] [Updated] (ACCUMULO-123) Dynamically generate configuration
documentation
Posted by "John Vines (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
John Vines updated ACCUMULO-123:
--------------------------------
Priority: Minor (was: Major)
Fix Version/s: (was: 1.4.0)
1.5.0
Due to the uncertainty of this course of action, I'm delaying this improvement for 1.5. This ticket is pretty trivial and should not be holding up a release.
And before I forget, another plan of action, which would be in depth, would be to allow a user to log in to the monitor pages and make configuration changes via the monitor in addition to just seeing the live configuration options. One step closer to having a GUI.
> 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
> Priority: Minor
> Fix For: 1.5.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
[jira] [Work started] (ACCUMULO-123) Dynamically generate
configuration documentation
Posted by "John Vines (Work started) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACCUMULO-123?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Work on ACCUMULO-123 started by John Vines.
> 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