Kristian Rickert created OPENNLP-1958:
-----------------------------------------
Summary: Methodical, controlled update of the docbook
Key: OPENNLP-1958
URL: https://issues.apache.org/jira/browse/OPENNLP-1958
Project: OpenNLP
Issue Type: Epic
Reporter: Kristian Rickert
Assignee: Kristian Rickert
As any software should do, we have to ramp up and fix our documentation before
a major release. It's assumed any PR has documentation updates, we will
continue to do that. But stuff drifts, people download the manual, they find a
bad example and some student might end up going back to python.
I'm going to do an effort to methodically update our documentation to have
consistent examples.
Improve the OpenNLP manual through small independent PRs. All branches will be
named OPENNLP-\{XXXX}-docs* where each branch is a chapter.
Some consistency I'll do:
# Make the examples all runnable.
# Create the examples as running tests.
# Make the class match the chapter name
This will be the epic that tracks all the Jira tickets for this effort.
Per PR, done means: the touched module compiles and its tests pass with
{{{}-Dopennlp.forkCount=1{}}}, the docbkx build renders, RAT and checkstyle are
clean, the diff touches only that chapter and its examples, and the description
states listings before, listings verified after, and anything left unverified
with the reason.
Standing rules: a doc PR never changes main source, and a real defect an
example exposes becomes its own code ticket. Branches stay cut from main
rather than stacked.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
