| Issue 4: | Documentation | |
| 3 people starred this issue and may be notified of changes. | Back to list |
Sign in to add a comment
|
Before release we need to have the following documentation: 1. How to build the software 2. How to install the software. This should be simple and consistent. Maybe there are two types of install 1) system install under /usr/share/hypertable or a home directory install under ~/hypertable. The java install is a nightmare. I would prefer to not allow people to install the software except for these two places (or make it difficult). No one should ever have trouble installing the software or locating where it is installed. 3. Architectural overview 4. C++ API reference 5. How to get up and running with Hypertable in 5 or 10 minutes. 6. Configuration property reference |
||||||||||
,
Dec 13, 2007
We should also have a library of examples. There should be an example of how to do *everything*. A great model for this is the Java Developer's Almanac (see http://www.exampledepot.com/). We should *never* just show BNF. There should always be accompanying examples. |
|||||||||||
,
Dec 28, 2007
We should also have a list of known bugs in each version. With one click, you should be able to get to a list of all bugs and their symptoms in each version. |
|||||||||||
,
Jan 10, 2008
(No comment was entered for this change.)
Labels: Milestone-Release1.1
|
|||||||||||
,
Jan 10, 2008
(No comment was entered for this change.)
Labels: -Milestone-Release1.1 Milestone-Release1.0
|
|||||||||||
,
Jan 25, 2008
The hypertable command interpreter should have complete documentation for each command along with a complete set of examples. There should be an example for every possible syntax (e.g. showing quotes around table names that contain non-alphanumeric characters, etc.) |
|||||||||||
,
Dec 18, 2008
We should also have documentation and a complete example for each Thrift language we support. |
|||||||||||
 Sign in to add a comment
|
|||||||||||
