Skip to content
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

Merged
merged 14 commits into from
Mar 20, 2023
Merged

Conversation

ljamen
Copy link
Contributor

@ljamen ljamen commented Mar 9, 2023

Addresses issue #6395

@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Mar 9, 2023
@ljamen ljamen marked this pull request as ready for review March 10, 2023 17:02
@ljamen ljamen requested review from tjquinno, barchetta and m0mus March 10, 2023 17:05
@ljamen ljamen self-assigned this Mar 10, 2023
@ljamen ljamen added docs 4.x Version 4.x labels Mar 10, 2023
@ljamen ljamen added this to the 4.0.0-RC1 milestone Mar 10, 2023
@ljamen
Copy link
Contributor Author

ljamen commented Mar 10, 2023

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.

Copy link
Member

@tjquinno tjquinno left a 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/includes/nima.adoc Show resolved Hide resolved
docs/about/doc_overview.adoc Show resolved Hide resolved
docs/nima/guides/health.adoc Outdated Show resolved Hide resolved
docs/nima/guides/health.adoc Outdated Show resolved Hide resolved
=== 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
Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted for tracking

Comment on lines 298 to 301
import org.eclipse.microprofile.metrics|.Counter;
|.Meter;
|.Timer;
|.ConcurrentGauge;
Copy link
Member

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created #6402 to track

docs/nima/metrics/metrics-capable-components.adoc Outdated Show resolved Hide resolved
docs/nima/metrics/metrics-capable-components.adoc Outdated Show resolved Hide resolved
docs/nima/metrics/micrometer.adoc Show resolved Hide resolved
@ljamen ljamen requested a review from tjquinno March 14, 2023 15:22
Copy link
Member

@tjquinno tjquinno left a 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.

@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo "usead" -> "used"

docs/includes/nima.adoc Show resolved Hide resolved

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.
Copy link
Member

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.

docs/nima/openapi.adoc Outdated Show resolved Hide resolved
docs/nima/openapi/openapi.adoc Show resolved Hide resolved
@ljamen ljamen merged commit 9bea016 into helidon-io:main Mar 20, 2023
@ljamen ljamen mentioned this pull request Aug 31, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.x Version 4.x docs OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants