-
Notifications
You must be signed in to change notification settings - Fork 564
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* new files for nima * update sitegen * add files * changed UC * updated i in Nima * remove accent i * added openapi * updated sitegen.yaml with openapi dirs * added openapi images * copyright fixes * updated copyright * added new lines to end * updated files for Tim * updates for openapi cors copyright
- Loading branch information
Showing
34 changed files
with
2,507 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
/////////////////////////////////////////////////////////////////////////////// | ||
|
||
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. | ||
|
||
/////////////////////////////////////////////////////////////////////////////// | ||
= Learn More About Helidon | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
/////////////////////////////////////////////////////////////////////////////// | ||
|
||
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. | ||
|
||
/////////////////////////////////////////////////////////////////////////////// | ||
= Features and Benefits of Helidon |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,143 @@ | ||
/////////////////////////////////////////////////////////////////////////////// | ||
|
||
Copyright (c) 2018, 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. | ||
|
||
/////////////////////////////////////////////////////////////////////////////// | ||
= Documentation Overview | ||
:description: Helidon | ||
:keywords: helidon, java, microservices, microprofile | ||
:rootdir: {docdir}/.. | ||
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] | ||
==== | ||
//Introduction to Helidon | ||
[CARD] | ||
.Introduction to Helidon | ||
[icon=lightbulb] | ||
-- | ||
New to Helidon? Start here to learn how Helidon's open-source set of Java libraries can help you write cloud-native Java microservices. | ||
xref:{rootdir}/about/introduction.adoc[What is Helidon?] | ||
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/intro.adoc[What's New in Helidon 4] | ||
-- | ||
//Getting Started | ||
[CARD] | ||
.Getting Started | ||
[icon=settings] | ||
-- | ||
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. | ||
xref:{rootdir}/about/prerequisites.adoc[Prerequisites and System Requirements] | ||
xref:{rootdir}/about/cli.adoc[Using the Helidon CLI] | ||
xref:{rootdir}/about/generating_project.adoc[Using Project Starter] | ||
xref:{rootdir}/mp/guides/quickstart.adoc[Using the MP Quickstart Guide] | ||
xref:{rootdir}/se/guides/quickstart.adoc[Using the SE Quick Start Guide] | ||
-- | ||
//Migration Guides | ||
[CARD] | ||
.Upgrading Helidon | ||
[icon=storage] | ||
-- | ||
Use the migration guides to help you upgrade your existing Helidon applications to the latest version of Helidon. | ||
xref:{rootdir}/mp/guides/migration_3x.adoc[Upgrade From Helidon MP 3.x] | ||
xref:{rootdir}/mp/guides/migration.adoc[Upgrade From Helidon MP 2.x] | ||
xref:{rootdir}/se/guides/migration_3x.adoc[Upgrade From Helidon SE 3.x] | ||
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] | ||
-- | ||
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. | ||
xref:{rootdir}/mp/guides/mp-tutorial.adoc[Helidon MP Tutorial] | ||
xref:{rootdir}/mp/guides/mp-tutorial.adoc[Helidon SE Tutorial] | ||
-- | ||
//How-To Guides | ||
[CARD] | ||
.How-To Guides | ||
[icon=graphic_eq] | ||
-- | ||
Ready for more hands-on learning? Explore the features of Helidon with these quick step-by-step guides. | ||
Nima Guides | ||
xref:{rootdir}/se/guides/overview.adoc[SE Guides] | ||
xref:{rootdir}/mp/guides/overview.adoc[MP Guides] | ||
-- | ||
//Helidon Nima | ||
[CARD] | ||
.Helidon Nima | ||
[icon=swap_horiz] | ||
-- | ||
-- | ||
//Helidon MP | ||
[CARD] | ||
.Helidon MP | ||
[icon=swap_horiz] | ||
-- | ||
-- | ||
//Helidon SE | ||
[CARD] | ||
.Helidon SE | ||
[icon=swap_horiz] | ||
-- | ||
-- | ||
==== | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
/////////////////////////////////////////////////////////////////////////////// | ||
|
||
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 Project Starter | ||
https://helidon.io/starter[Helidon Project Starter] allows you to choose from a set of archetypes with pre-defined feature sets and lets you customize it by providing a host of options. | ||
== Select a Flavor | ||
=== Helidon SE | ||
=== Helidon MP | ||
=== Nima | ||
== Choose an Application Type | ||
Helidon provides the following set of archetypes to bootstrap your application development journey. | ||
=== QuickStart | ||
This option creates a Helidon project that includes multiple REST operations along with default observability setup and a set of dependencies to enable ease of development e.g. in case of Helidon MP, it uses `helidon-microprofile` bundle instead of minimal `helidon-microprofile-core` bundle. | ||
=== Database | ||
This option builds on `QuickStart` to demonstrate how to integrate with database (in-memory H2, by default). In case of, Helidon SE that uses the DbClient API while for Helidon MP that uses JPA. | ||
=== Custom | ||
This option enables user to create Helidon project of their choice, suitable to start from scratch i.e. bare minimum, if default values are chosen Or choose from many options available. | ||
=== OCI (MP Only) | ||
This option builds on `QuickStart` to demonstrate integration with Oracle Cloud Infrastructure (OCI) services using the OCI SDK. Generated project showcases OpenApi-driven development approach where the practice of designing and building APIs is done first, then creating the rest of an application around them is implemented next. This is available for Helidon MP only. | ||
== Media Support Options | ||
=== Jackson JSON | ||
=== JSON-B | ||
Default. | ||
=== JSON-P (SE Only) | ||
== Customize Project | ||
* groupId | ||
* artifactId | ||
* Project Version | ||
* Java package name | ||
== Download the Project Files | ||
Click *Download* and Project Starter generates the files in a directory named after the `artifactId` value. It mainly contains the following: | ||
* Maven structure | ||
* skeletal application code | ||
* associated unit test code | ||
* example Dockerfile files | ||
* application configuration file(s) | ||
* Readme file with instructions to build and run application/test | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
/////////////////////////////////////////////////////////////////////////////// | ||
|
||
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. | ||
|
||
/////////////////////////////////////////////////////////////////////////////// | ||
= Introducing Helidon 4 | ||
:description: Helidon | ||
:keywords: helidon, java, microservices | ||
:rootdir: {docdir}/.. | ||
== What's New in This Release | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.