-
Notifications
You must be signed in to change notification settings - Fork 566
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCS: Add new dirs and docs for Nima 4 #6398
Conversation
This PR addresses #6395 and includes additional updates to ensure that dependencies are available for the new Nima docs. As requested, I started with copies of the SE docs and created 'blanks' for most of the new Nima docs. I say 'most' because for some of the new docs I had to keep the SE content in place or the builds would fail with missing dependencies. All of this will be addressed in the main branch once we start working on the Nima docs and new content. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Among other things, I noted quite a few places where SE remains (instead of Nima) and I apologize if those were already on the list to be taken care of.
docs/nima/guides/health.adoc
Outdated
=== Custom Liveness Health Checks | ||
|
||
You can create application specific custom health checks and integrate them with Helidon | ||
using the `HealthSupport` class, which is a WebServer service that contains |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In Níma, in most (all?) cases the xxxSupport
classes are replaced with xxxFeature
. Or will be once we get the Níma work done. The same change might be needed in other files beyond this one. I won't flag those separately.
Note that if/for however long we keep reactive in Helidon, the SE (reactive) doc should refer to the xxxSupport
classes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted for tracking
docs/nima/guides/webclient.adoc
Outdated
import org.eclipse.microprofile.metrics|.Counter; | ||
|.Meter; | ||
|.Timer; | ||
|.ConcurrentGauge; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here and below, can we convey that the developer can choose among different metrics types using legal Java syntax (maybe comment the succeeding lines or something?), so readers can copy and paste?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Created #6402 to track
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've noted a few possible changes.
docs/nima/guides/config.adoc
Outdated
@@ -23,7 +23,7 @@ | |||
:rootdir: {docdir}/../.. | |||
include::{rootdir}/includes/nima.adoc[] | |||
|
|||
This guide describes how to create a sample Helidon Nima project that can be uNimad to run some | |||
This guide describes how to create a sample Helidon Nima project that can be usead to run some |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo "usead" -> "used"
|
||
include::{rootdir}/includes/nima.adoc[] | ||
|
||
In this guide you fill find basic advice for performance tuning of your Helidon application. Most of them target Netty tuning, as Helidon is based on it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I edited the previous comment; I probably should have just written a new one for the "you fill find" typo.
Addresses issue #6395