Yes, option 3: a new /tutorials section on opennlp.apache.org (we can add
/blog later), with the sources in opennlp-site and the usual PR review. The
aim is one article a month.

Where: opennlp.apache.org/tutorials. Sources go in apache/opennlp-site
under src/main/jbake/content/tutorials and publish to asf-site the same way
the rest of the site does.

Format:
* Markdown would be new, but JBake already supports it with one extra
dependency (flexmark).
* The interactive parts are small self-contained JavaScript files next to
each article, embedded with a plain div and script tag. Think of the visual
explainers in NYT articles or 3Blue1Brown videos, not a frontend app.  It
will be self-contained and not load from external CDNs (all the normal
stuff you'd assume from any professional website)
* Code examples: the real code lives in apache/opennlp (or opennlp-addons).
Articles link to it (maybe with permalinks on a release tag?, so the links
don't break when main moves?)..
* Review: a normal PR on opennlp-site with the usual approvals. On top of
that, one of us acts as editor for each article. The editor gives the
writer a clear yes or no early on and helps get the piece over the line.

The motivation is to give new contributors a low barrier to entry: write
Markdown and open a PR. The visuals are optional, and we can help add them.

As a test, I'll make the first tutorial.  It'll be an initial "download and
go" to cover the major parts of our code.

All of them will have a readtime of about a few minutes to half an hour?
Anything longer would be split into parts.

On Mon, Nov 16, 2026 at 3:16 AM Richard Zowalla via dev <
[email protected]> wrote:

> Hi Kristian,
>
> thanks for the details, but I'm still not sure I understand what you have
> in mind.
> Which blog are we talking about exactly?
>
> I see a few options:
>
> 1. news.apache.org: one-off posts, coordinated with markpub. Probably
> fine for a 3.0 announcement, but not for a regular tutorial series.
> 2. A section on our own website (opennlp.apache.org), e.g. as part of the
> existing /news section.
> 3. A new section on our website, e.g. /blog or /tutorials.
>
> From your description (monthly cadence, interactive tutorials, live
> examples, community contributions, reviewed like code),
> it sounds like 2 or 3, with the sources living in the website repo and
> going through the usual PR review.
>
> Is that right?
>
> Could you put together a short, concrete proposal covering:
>
> - where it lives (URL / repo),
> - the format (Markdown? JBake like the rest of the site? how would the
> "interactive" parts and animations work?),
> - how examples are linked to code in the main repo,
> - the review/publishing process (normal 2-approver PR?).
>
> A short, concrete proposal would make it much easier for everyone to give
> feedback (or a +1).
>
> Gruß
> Richard
>
> On 2026/11/15 21:07:51 Kristian Rickert via dev wrote:
> > News would be a great "in addition to" thing.  I'd want to have an
> > interactive tutorial or to go over some of the speed challenges we faced
> -
> > or to get write ups from the community.  We have enough new features to
> > regularly land on a monthly schedule. We could invite the public to
> > contribute as well.  It'll have live examples and minor animations that
> are
> > relevant to the lesson.
> >
> > I think the way we're extending opennlp has a lot of potential.  And some
> > good starter templates in the form of a tutorial goes a long way.  I'd
> keep
> > up with them.  Of course the examples would go in the codebase as well.
> >
> > I'd recommend that because they'd be tied to examples in the code, it
> would
> > be reviewed as a code review.
> >
> > If it doesn't work out, we can archive it.  I'll offer to manage the
> queue.
> >
> > Kristian
> >
> >
> > On Sun, Nov 15, 2026 at 2:45 PM Richard Zowalla via dev <
> > [email protected]> wrote:
> >
> > > I think standard blog posts on https://news.apache.org/ can also be a
> bit
> > > technical
> > >
> https://news.apache.org/foundation/entry/apache-geode-2-0-part-ii-rebuilding-a-distributed-system-for-the-modern-java-era
> > > Nut not that big in that case. I think the correct way would be to
> write
> > > something and than coordinate with markpub (who owns news.a.o AFAIK).
> > >
> > > Or which blog are you talking about?
> > >
> > > > Am 15.11.2026 um 19:13 schrieb Kristian Rickert via dev <
> > > [email protected]>:
> > > >
> > > > Bumping this - anyone know how we would publish a blog post?  I'd
> > > volunteer
> > > > to be an "editor" of it - or just our usual 2-approver push?
> > > >
> > > > There's no rush - but hoping to get a signal that this is still in
> our
> > > plan.
> > > >
> > > > I'd love to have e2e tutorials on how to use our new features.  I'd
> > > publish
> > > > them post-launch.
> > > >
> > > > Kristian
> > > >
> > > >
> > > >
> > > >
> > > > On Tue, Nov 10, 2026 at 8:39 AM Kristian Rickert <
> [email protected]>
> > > > wrote:
> > > >
> > > >> Hi Team,
> > > >>
> > > >> I am available to help with final tasks to ensure the 3.0 release is
> > > >> solid, so please let me know where I can assist.  This email
> includes
> > > some
> > > >> initial suggestions.  Feel free to reach out to me over slack too.
> > > >>
> > > >> Specifically for the developers: I'd like to focus a bit on
> > > >> doucmentation.  If there are any examples you feel are currently
> weak,
> > > >> please point them out and I will add better examples and convert
> them
> > > into
> > > >> tests.
> > > >>
> > > >> Regarding release prep and post-release plans:
> > > >>
> > > >>
> > > >> *1. Release Priorities & Timeline*
> > > >>  - We can easily follow up with a 3.0.1 or 3.1 release shortly
> after, so
> > > >> there is no rush on the items below.
> > > >>  - Personally, I consider none of these tasks finalized until our
> core
> > > >> release duties are completed.
> > > >>
> > > >>
> > > >> *2. Blog*
> > > >>  - As discussed, where and how should we host the blog?  I want to
> > > >> release something on a regular cadence.  I'd suggest that outside
> > > articles
> > > >> from volunteers will take precedence over those from non-volunteers.
> > > >>
> > > >> *3. Add-ons Strategy*
> > > >>
> > > >> Rather than risking a flood of PRs, I propose using add-ons to
> engage
> > > >> community volunteers:
> > > >> - *Start with a github issue.* Instead of keeping deferred features
> in
> > > >> main PRs, I will turn them into issues for volunteers to take on.
> > > >>  - *Process*: Anyone wanting a new add-on would create an issue in
> > > >> OpenNLP issues.
> > > >>  - *Starter Branches*: If code was previously started for a feature,
> > > >> volunteers can use it as a baseline. (We've seen great results with
> this
> > > >> recently, where volunteers submitted higher-quality code than the
> > > initial
> > > >> draft).
> > > >>  - *Lower Barrier to Entry*: Add-ons would have a lower
> contribution bar
> > > >> to allow for experimentation and specific dependencies (e.g., an S3
> > > >> outputter).
> > > >>  - *Maintenance*: If an add-on proves unuseful, incurs high
> maintenance
> > > >> overhead, or is abandoned, we can simply remove it.
> > > >>  -* Current Status*: I have one add-on ready to release right after
> the
> > > >> main launch, along with about a dozen tickets for advanced NLP
> > > features.  I
> > > >> don't plan to push them all at once, rather at the team's pace.
> > > >>
> > > >> Please let me know if you have any thoughts or objections to this
> > > approach.
> > > >>
> > > >> Best rungards,
> > > >> Kristian Rickert
> > > >>
> > > >>
> > >
> > >
> >
>

Reply via email to