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
18 changes: 17 additions & 1 deletion docs/about/additional_info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,21 @@

///////////////////////////////////////////////////////////////////////////////

= Learn More About Helidon
= Helidon Community and Support References
:description: Helidon community links and references
:keywords: helidon, java, microservices, microprofile, documentation, nima
:rootdir: {docdir}/..


include::{rootdir}/includes/attributes.adoc[]

Here are some additional resources you can use to get started, get help, and to follow the evolution of Helidon.


* Project website: https://helidon.io
* Medium publication: https://medium.com/helidon
* GitHub repository: https://github.com/helidon-io/helidon
* Public Slack workspace: https://slack.helidon.io/
* Twitter account: https://twitter.com/helidon_project
* YouTube channel: https://www.youtube.com/channel/UChg00-uTTrCMmPsuzUNaZsA[https://www.youtube.com/channel/UChg00-uTTrCMmPsuzUNaZsA]
* Stack Overflow tag: https://stackoverflow.com/tags/helidon
30 changes: 16 additions & 14 deletions docs/about/doc_overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@

///////////////////////////////////////////////////////////////////////////////

= Documentation Overview
= Helidon Documentation
:description: Helidon
:keywords: helidon, java, microservices, microprofile
:keywords: helidon, java, microservices, microprofile, documentation, nima
:rootdir: {docdir}/..

Check out the xref:{rootdir}/about/doc_sitemap.adoc[Documentation Overview] for information about this site and the materials we provide.

include::{rootdir}/includes/attributes.adoc[]

This is test to see if this displays. Can we add some text about what's included in the docs?


[PILLARS]
====
Expand All @@ -40,7 +42,7 @@ xref:{rootdir}/about/benefits.adoc[Features and Benefits]

xref:{rootdir}/about/archetype.adoc[Helidon Archetypes]

xref:{rootdir}/about/additional_info.adoc[Reference and Community Resources]
xref:{rootdir}/about/additional_info.adoc[Helidon Community and Support]

xref:{rootdir}/about/intro.adoc[What's New in Helidon 4]

Expand All @@ -49,9 +51,9 @@ xref:{rootdir}/about/intro.adoc[What's New in Helidon 4]
//Getting Started
[CARD]
.Getting Started
[icon=settings]
[icon=rocket_launch]
--
There are several ways to generate your first Helidon project. In a hurry? The Helidon CLI and Project Starter provide a set of predefined archetypes to choose from. Or try the Quickstart guides for the standard Helidon Maven archetypes.
There are several ways to generate your first Helidon project. In a hurry? Try the Helidon CLI or Project Starter which provide a set of predefined archetypes to choose from.

xref:{rootdir}/about/prerequisites.adoc[Prerequisites and System Requirements]

Expand Down Expand Up @@ -88,7 +90,7 @@ xref:{rootdir}/se/guides/migration.adoc[Upgrade From Helidon SE 2.x]
//Developing Your First Application
[CARD]
.Developing Your First Application From Scratch
[icon=share]
[icon=terminal]
--
Use these hands-on development tutorials to learn how to generate a small "Hello World!" greeting service that demonstrates some of Helidon's core features.

Expand All @@ -101,37 +103,37 @@ xref:{rootdir}/mp/guides/mp-tutorial.adoc[Helidon SE Tutorial]
//How-To Guides
[CARD]
.How-To Guides
[icon=graphic_eq]
[icon=library_books]
--
Ready for more hands-on learning? Explore the features of Helidon with these quick step-by-step guides.

Nima Guides
xref:{rootdir}/nima/guides/overview.adoc[Níma Guides]

xref:{rootdir}/se/guides/overview.adoc[SE Guides]

xref:{rootdir}/mp/guides/overview.adoc[MP Guides]

--
//Helidon Nima
//Advanced Features
[CARD]
.Helidon Nima
.Advanced Features
[icon=swap_horiz]
--

--


//Helidon MP
//Training and Certification
[CARD]
.Helidon MP
[icon=swap_horiz]
--

--

//Helidon SE
//Helidon Níma
ljamen marked this conversation as resolved.
Show resolved Hide resolved
[CARD]
.Helidon SE
.Helidon Níma
[icon=swap_horiz]
--

Expand Down
48 changes: 48 additions & 0 deletions docs/about/doc_sitemap.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

///////////////////////////////////////////////////////////////////////////////

= Helidon Documentation Overview
:description: Helidon Documentation Sitemap
:keywords: helidon, java, microservices, microprofile, documentation, nima
:rootdir: {docdir}/..

== Using This Site

Welcome to the Helidon documentation site. Here you will find general concepts, quickstart guides, tutorials and reference material. Existing Helidon users can go directly to their preferred programming flavor in the navigation panel to the left.

=== New Users

New to Helidon? Start with the xref:{rootdir}/about/introduction.adoc[Helidon Documentation] page. Here you will find some of the most common topics for getting started as well as easy first steps for building your first project or application.

Once you've settled on your preferred programming framework, visit the Helidon flavor sections of this site for more information.

* xref:{rootdir}/nima/introduction.adoc[Helidon Nima]
* xref:{rootdir}/se/introduction.adoc[Helidon SE]
* xref:{rootdir}/mp/introduction.adoc[Helidon MP]


=== Existing Helidon Users

Welcome back! The documentation site has a couple of new features that we hope will make your experience here a bit easier.

The new xref:{rootdir}/about/introduction.adoc[Helidon Documentation] page offers quick links to some of our most popular topics, including our new training and certification programs.

Check out the xref:{rootdir}/about/intro.adoc[What's New in Helidon 4] for a list of new features and functionality.



Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions docs/includes/nima.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@ ifndef::flavor-included[]
ifndef::rootdir[:rootdir: {docdir}/..]
include::{rootdir}/includes/attributes.adoc[]

:h1-prefix: Níma
:flavor-uc: Níma
:h1-prefix: Nima
ljamen marked this conversation as resolved.
Show resolved Hide resolved
:flavor-uc: Nima
ljamen marked this conversation as resolved.
Show resolved Hide resolved
:flavor-lc: nima
:nima-flavor: true

include::{rootdir}/includes/pages.adoc[]

endif::flavor-included[]
1 change: 1 addition & 0 deletions docs/includes/openapi/openapi.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The link:{microprofile-open-api-spec-url}[MicroProfile OpenAPI spec] explains ho

ifdef::mp-flavor[Helidon {flavor-uc} implements the MicroProfile OpenAPI specification.]
ifdef::se-flavor[OpenAPI support in Helidon {flavor-uc} draws its inspiration from MicroProfile OpenAPI but does not implement the spec because Helidon {flavor-uc} does not support annotations.]
ifdef::nima-flavor[OpenAPI support in Helidon {flavor-uc} draws its inspiration from MicroProfile OpenAPI but does not implement the spec because Helidon {flavor-uc} does not support annotations.]

The OpenAPI support in Helidon {flavor-uc} performs two main tasks:

Expand Down
8 changes: 7 additions & 1 deletion docs/includes/pages.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ ifdef::mp-flavor[]
:metrics-page: {rootdir}/mp/metrics/metrics.adoc
:openapi-page: {rootdir}/mp/openapi/openapi.adoc
endif::[]
:webclient-page: {rootdir}/se/webclient.adoc
ifdef::nima-flavor[]
:health-page: {rootdir}/nima/health.adoc
:metrics-page: {rootdir}/nima/metrics/metrics.adoc
:openapi-page: {rootdir}/nima/openapi/openapi.adoc
endif::[]

:webclient-page: {rootdir}/nima/webclient.adoc
:restclient-page: {rootdir}/mp/restclient.adoc
:cli-page: {rootdir}/about/cli.adoc
28 changes: 28 additions & 0 deletions docs/nima/aot.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

///////////////////////////////////////////////////////////////////////////////

= GraalVM Native Image
:description: Helidon AOT using GraalVM native-image
:keywords: helidon, aot, native, native-image, image, executable, nima
:rootdir: {docdir}/..

include::{rootdir}/includes/nima.adoc


== TO DO FOR NIMA

Loading