Re: [VOTE] Release UIMA Ruta 2.7.0 RC1

[Marshall Schor <ms...@schor.com>]

Are the new features / changes properly reflected in the ruta-docbook documentation?

(A compare of the 2.6.1 and 2.7.0 releases shows just minor changes.)

-Marshall

Re: [VOTE] Release UIMA Ruta 2.7.0 RC1

[Marshall Schor <ms...@schor.com>]

ok, not a blocker... just mentioned it in case it was overlooked. -Marshall

On 2/1/2019 12:17 PM, Peter Klügl wrote:
> Hi,
>
>
> Am 01.02.2019 um 17:07 schrieb Marshall Schor:
>> Are the new features / changes properly reflected in the ruta-docbook documentation?
>
> Hmm, I do not know if I can answer this question. It depends on the
> interpretation of "properly".
>
>
> I tried to mention/integrate each change in the documentation. The size
> of a diff is not directly proportional to the importance of a new feature.
>
> In my opinion, examples are missing in "Learning by example" for the new
> language features, but "optional" got its own section, "labels at
> actions" is mentioned in the syntax section and the multiple inlined
> rules in its section.
>
> The new configuration parameters are described in the corresponding section.
>
>
> There should be more documentation for the new (and also old) stuff and
> users will certainly require more documentation and especially more
> examples to fully utilize the features. There is also the option to
> provide patches or ask for more documentation in a ticket...
>
>
> I think the documentation has also a problem when comparing the
> structure to its size. I noticed that users have a hard time to find
> specific information in the 120 pages (or they do not even look at it).
> There should maybe be more redundant descriptions in orthogonal
> chapters, more examples and howtos compared to the reference.
>
>
> Best,
>
>
> Peter
>
>
>
>> (A compare of the 2.6.1 and 2.7.0 releases shows just minor changes.)
>>
>> -Marshall
>>

Re: [VOTE] Release UIMA Ruta 2.7.0 RC1

[Peter Klügl <pe...@averbis.com>]

Hi,


Am 01.02.2019 um 17:07 schrieb Marshall Schor:
> Are the new features / changes properly reflected in the ruta-docbook documentation?


Hmm, I do not know if I can answer this question. It depends on the
interpretation of "properly".


I tried to mention/integrate each change in the documentation. The size
of a diff is not directly proportional to the importance of a new feature.

In my opinion, examples are missing in "Learning by example" for the new
language features, but "optional" got its own section, "labels at
actions" is mentioned in the syntax section and the multiple inlined
rules in its section.

The new configuration parameters are described in the corresponding section.


There should be more documentation for the new (and also old) stuff and
users will certainly require more documentation and especially more
examples to fully utilize the features. There is also the option to
provide patches or ask for more documentation in a ticket...


I think the documentation has also a problem when comparing the
structure to its size. I noticed that users have a hard time to find
specific information in the 120 pages (or they do not even look at it).
There should maybe be more redundant descriptions in orthogonal
chapters, more examples and howtos compared to the reference.


Best,


Peter



> (A compare of the 2.6.1 and 2.7.0 releases shows just minor changes.)
>
> -Marshall
>
-- 
Dr. Peter Klügl
R&D Text Mining/Machine Learning

Averbis GmbH
Tennenbacher Str. 11
79106 Freiburg
Germany

Fon: +49 761 708 394 0
Fax: +49 761 708 394 10
Email: peter.kluegl@averbis.com
Web: https://averbis.com

Headquarters: Freiburg im Breisgau
Register Court: Amtsgericht Freiburg im Breisgau, HRB 701080
Managing Directors: Dr. med. Philipp Daumke, Dr. Kornél Markó