diff --git a/docs/about/doc_overview.adoc b/docs/about/doc_overview.adoc index ee72be68864..fbcc105389f 100644 --- a/docs/about/doc_overview.adoc +++ b/docs/about/doc_overview.adoc @@ -66,16 +66,16 @@ xref:{rootdir}/se/guides/quickstart.adoc[Using the SE Quick Start Guide] -- -//Migration Guides +//Upgrade Guides [CARD] .Upgrading Helidon [icon=storage] -- -Use the migration guides to help you upgrade your existing Helidon applications to the latest version of Helidon. +Use the upgrade guides to help you upgrade your existing Helidon applications to the latest version of Helidon. -xref:{rootdir}/mp/guides/migration_4x.adoc[Upgrade From Helidon MP 4.x] +xref:{rootdir}/mp/guides/upgrade_4x.adoc[Upgrade From Helidon MP 4.x] -xref:{rootdir}/se/guides/migration_4x.adoc[Upgrade From Helidon SE 4.x] +xref:{rootdir}/se/guides/upgrade_4x.adoc[Upgrade From Helidon SE 4.x] -- diff --git a/docs/about/introduction.adoc b/docs/about/introduction.adoc index 66cc0f473dc..3392aa2a356 100644 --- a/docs/about/introduction.adoc +++ b/docs/about/introduction.adoc @@ -127,27 +127,26 @@ include::{rootdir}/includes/prerequisites.adoc[tag=prerequisites-table-details] // end::prereqs[] We also strongly suggest installing the xref:cli.adoc[Helidon CLI] (command line interface) which helps in generating and building Helidon projects. -== Migration +== Upgrade -To upgrade your current version of Helidon, follow the `Migration Guides`: +To upgrade your current version of Helidon, follow the `Upgrade Guides`: -To migrate from from Helidon 3.x to 4.x: +To upgrade from Helidon 3.x to 4.x: -//Mitia to create these guides for 4x -* xref:{rootdir}/se/guides/migration_4x.adoc[Helidon SE 4x Migration Guide] -* xref:{rootdir}/mp/guides/migration_4x.adoc[Helidon MP 4x Migration Guide] +* xref:{rootdir}/se/guides/upgrade_4x.adoc[Helidon SE 4x Upgrade Guide] +* xref:{rootdir}/mp/guides/upgrade_4x.adoc[Helidon MP 4x Upgrade Guide] -To migrate from Helidon 2.x to 3.x: +To upgrade from Helidon 2.x to 3.x: -* xref:{rootdir}/se/guides/migration_3x.adoc[Helidon SE 3x Migration Guide] -* xref:{rootdir}/mp/guides/migration_3x.adoc[Helidon MP 3x Migration Guide] +* xref:{rootdir}/se/guides/upgrade_3x.adoc[Helidon SE 3x Upgrade Guide] +* xref:{rootdir}/mp/guides/upgrade_3x.adoc[Helidon MP 3x Upgrade Guide] -To migrate from Helidon 1.x to 2.x: +To upgrade from Helidon 1.x to 2.x: -* xref:{rootdir}/se/guides/migration.adoc[Helidon SE 2x Migration Guide] -* xref:{rootdir}/mp/guides/migration.adoc[Helidon MP 2x Migration Guide] +* xref:{rootdir}/se/guides/upgrade.adoc[Helidon SE 2x Upgrade Guide] +* xref:{rootdir}/mp/guides/upgrade.adoc[Helidon MP 2x Upgrade Guide] == Next Steps diff --git a/docs/includes/guides/migration.adoc b/docs/includes/guides/upgrade.adoc similarity index 100% rename from docs/includes/guides/migration.adoc rename to docs/includes/guides/upgrade.adoc diff --git a/docs/includes/guides/upgrade_3x.adoc b/docs/includes/guides/upgrade_3x.adoc index 41c7d0c7a31..ede0d4a0cf8 100644 --- a/docs/includes/guides/upgrade_3x.adoc +++ b/docs/includes/guides/upgrade_3x.adoc @@ -27,5 +27,5 @@ include::../attributes.adoc[] Helidon 3.x is not fully backwards compatible with Helidon 2.x. For information concerning upgrading from Helidon 2.x to 3.x see the following upgrade guides: -* xref:../mp/guides/migration_3x.adoc[Helidon MP 3.x Upgrade Guide] -* xref:../se/guides/migration_3x.adoc[Helidon SE 3.x Upgrade Guide] +* xref:../mp/guides/upgrade_3x.adoc[Helidon MP 3.x Upgrade Guide] +* xref:../se/guides/upgrade_3x.adoc[Helidon SE 3.x Upgrade Guide] diff --git a/docs/includes/guides/upgrade_4x.adoc b/docs/includes/guides/upgrade_4x.adoc index 34cd5a421d4..b3afc3ec4ee 100644 --- a/docs/includes/guides/upgrade_4x.adoc +++ b/docs/includes/guides/upgrade_4x.adoc @@ -27,5 +27,5 @@ include::../attributes.adoc[] Helidon 4.x is not fully backwards compatible with Helidon 3.x. For information concerning upgrading from Helidon 3.x to 4.x see the following upgrade guides: -* xref:../mp/guides/migration_4x.adoc[Helidon MP 4.x Upgrade Guide] -* xref:../se/guides/migration_4x.adoc[Helidon SE 4.x Upgrade Guide] +* xref:../mp/guides/upgrade_4x.adoc[Helidon MP 4.x Upgrade Guide] +* xref:../se/guides/upgrade_4x.adoc[Helidon SE 4.x Upgrade Guide] diff --git a/docs/mp/guides/overview.adoc b/docs/mp/guides/overview.adoc index 552b34b764e..76cba951405 100644 --- a/docs/mp/guides/overview.adoc +++ b/docs/mp/guides/overview.adoc @@ -76,7 +76,7 @@ Learn how to build a Helidon MicroProfile (MP) application from scratch. [CARD] .Helidon MP Upgrade guide -[link=migration.adoc] +[link=upgrade.adoc] -- Learn how to upgrade your Helidon MP application from 1.x to 2.x. -- diff --git a/docs/mp/guides/migration.adoc b/docs/mp/guides/upgrade.adoc similarity index 99% rename from docs/mp/guides/migration.adoc rename to docs/mp/guides/upgrade.adoc index ff8e7ece616..38386c55e69 100644 --- a/docs/mp/guides/migration.adoc +++ b/docs/mp/guides/upgrade.adoc @@ -29,7 +29,7 @@ will help you migrate a Helidon MP 1.x application to 2.x. -include::{rootdir}/includes/guides/migration.adoc[] +include::{rootdir}/includes/guides/upgrade.adoc[] == MicroProfile Bundles diff --git a/docs/mp/guides/migration_3x.adoc b/docs/mp/guides/upgrade_3x.adoc similarity index 100% rename from docs/mp/guides/migration_3x.adoc rename to docs/mp/guides/upgrade_3x.adoc diff --git a/docs/mp/guides/migration_4x.adoc b/docs/mp/guides/upgrade_4x.adoc similarity index 100% rename from docs/mp/guides/migration_4x.adoc rename to docs/mp/guides/upgrade_4x.adoc diff --git a/docs/mp/introduction.adoc b/docs/mp/introduction.adoc index d23299add40..bfef7f6ad02 100644 --- a/docs/mp/introduction.adoc +++ b/docs/mp/introduction.adoc @@ -144,21 +144,21 @@ Helidon MP is an Eclipse MicroProfile {version-lib-microprofile-api} runtime tha !=== -== Migration +== Upgrade -In case you need to upgrade the version of Helidon, follow the `Migration Guides`. +In case you need to upgrade the version of Helidon, follow the `Upgrade Guides`. -For migration from Helidon 1.x to 2.x: +For upgrade from Helidon 1.x to 2.x: -* xref:{rootdir}/mp/guides/migration.adoc[Helidon MP 2x Migration Guide] +* xref:{rootdir}/mp/guides/upgrade.adoc[Helidon MP 2x Upgrade Guide] -For migration from Helidon 2.x to 3.x: +For upgrade from Helidon 2.x to 3.x: -* xref:{rootdir}/mp/guides/migration_3x.adoc[Helidon MP 3x Migration Guide] +* xref:{rootdir}/mp/guides/upgrade_3x.adoc[Helidon MP 3x Upgrade Guide] -For migration from Helidon 3.x to 4.x: +For upgrade from Helidon 3.x to 4.x: -* xref:{rootdir}/mp/guides/migration_4x.adoc[Helidon MP 4x Migration Guide] +* xref:{rootdir}/mp/guides/upgrade_4x.adoc[Helidon MP 4x Upgrade Guide] == Next Steps diff --git a/docs/se/guides/overview.adoc b/docs/se/guides/overview.adoc index ae325540272..c50af7d9d3a 100644 --- a/docs/se/guides/overview.adoc +++ b/docs/se/guides/overview.adoc @@ -77,7 +77,7 @@ Learn how to set up an OIDC Helidon SE application [CARD] .Helidon SE Upgrade Guide -[link=migration.adoc] +[link=upgrade.adoc] -- Learn how to Upgrade your Helidon SE application -- diff --git a/docs/se/guides/migration.adoc b/docs/se/guides/upgrade.adoc similarity index 99% rename from docs/se/guides/migration.adoc rename to docs/se/guides/upgrade.adoc index 2131857a656..753cb08f990 100644 --- a/docs/se/guides/migration.adoc +++ b/docs/se/guides/upgrade.adoc @@ -26,7 +26,7 @@ include::{rootdir}/includes/se.adoc[] In Helidon 2 we have made some changes to APIs and runtime behavior. This guide will help you migrate a Helidon SE 1.x application to 2.x. -include::{rootdir}/includes/guides/migration.adoc[] +include::{rootdir}/includes/guides/upgrade.adoc[] == Getters diff --git a/docs/se/guides/migration_3x.adoc b/docs/se/guides/upgrade_3x.adoc similarity index 100% rename from docs/se/guides/migration_3x.adoc rename to docs/se/guides/upgrade_3x.adoc diff --git a/docs/se/guides/migration_4x.adoc b/docs/se/guides/upgrade_4x.adoc similarity index 95% rename from docs/se/guides/migration_4x.adoc rename to docs/se/guides/upgrade_4x.adoc index c40a8ca4312..4e170e451c7 100644 --- a/docs/se/guides/migration_4x.adoc +++ b/docs/se/guides/upgrade_4x.adoc @@ -35,7 +35,7 @@ Helidon 4 no more uses Netty. Helidon SE is now running on Helidon WebServer whi Helidon SE has changed from an asynchronous style API to an imperative/blocking style API that is optimized for use with virtual threads. Currently, there is no compatibility API available -== Server initialization and start up +== Server Initialization and Start Up In Helidon 1.x-3.x to star a server, the following actions should be done: @@ -97,7 +97,7 @@ public static void main(String[] args) { Just create it, configure it, and wait for it to start. If any exceptions happen, they are handled the traditional way using available language constructions. -== Routing configuration +== Routing Configuration In Helidon 1.x-3.x the routing config was done the following way: @@ -125,7 +125,7 @@ private static Routing createRouting(Config config) { <3> Register `Metrics` and `Heath` support as Helidon Services. <4> Register the regular Greeting service. -Services are created and assigned to the desired path. Observability and other features are being created as usual Helidon `services`, available as part of the framework. Uses defined services are also registered the same way. +Services are created and assigned to the desired path. Observability and other features are being created as usual Helidon `services`, available as part of the framework. User-defined services are also registered the same way. In Helidon 4, the routing is configured the following way: @@ -204,11 +204,11 @@ public class GreetService implements HttpService { <1> Helidon 4 introduced `HttpService` that should be implemented in order to process HTTP requests. To set up routing, the method `routing(HttpRules rules)` should now be used. It receives `HttpRules` object with routes description. -These changes make Helidon 4 incompatible with previous versions. +WARNING: These changes make Helidon 4 incompatible with previous versions. Learn more about `HttpService` and `Routing` at xref:../webserver.adoc[Helidon SE WebServer] -=== Significant changes +=== Significant Changes ==== Testing @@ -223,11 +223,11 @@ There is a new testing framework for Helidon SE. ---- -Find more information proceed to xref:../introduction.adoc[Helidon SE testing] +Find more information, see xref:../introduction.adoc[Helidon SE testing] ==== Observability -Observability features of Helidon have now moved to different package. For `Heath` and `Metrics` please use: +Observability features of Helidon have now moved to different package. For `Health` and `Metrics` please use: [source, xml] ---- @@ -241,7 +241,7 @@ Observability features of Helidon have now moved to different package. For `Heat ---- -Observability has new endpoints. +Observability has new endpoints. See them xref:../observability.adoc[here]. For System Metrics, please use: diff --git a/docs/se/introduction.adoc b/docs/se/introduction.adoc index eb6020181a7..f805fd67411 100644 --- a/docs/se/introduction.adoc +++ b/docs/se/introduction.adoc @@ -158,35 +158,32 @@ Enables Java applications to participate in WebSocket interactions as both serve -== Migration +== Upgrade In case you need to upgrade the version of Helidon, follow the `upgrade guides`. [PILLARS] ==== [CARD] -.Helidon SE 2.x Migration Guide -[icon=upgrade,link=guides/migration.adoc] +.Helidon SE 2.x Upgrade Guide +[icon=upgrade,link=guides/upgrade.adoc] -- Follow this guide to migrate your application from Helidon 1.x to 2.x. -- [CARD] -.Helidon SE 3x Migration Guide -[icon=upgrade,link=guides/migration_3x.adoc] +.Helidon SE 3x Upgrade Guide +[icon=upgrade,link=guides/upgrade_3x.adoc] -- Follow this guide to migrate your application from Helidon 2.x to 3.x. -- - [CARD] -.Helidon SE 4x Migration Guide -[icon=upgrade,link=guides/migration_4x.adoc] +.Helidon SE 4x Upgrade Guide +[icon=upgrade,link=guides/upgrade_4x.adoc] -- Follow this guide to migrate your application from Helidon 3.x to 4.x. -- - - ==== diff --git a/docs/sitegen.yaml b/docs/sitegen.yaml index 9899bf19e38..eefe1e3c41b 100644 --- a/docs/sitegen.yaml +++ b/docs/sitegen.yaml @@ -314,9 +314,9 @@ backend: - "metrics.adoc" - "security-oidc.adoc" - "tracing.adoc" - - "migration.adoc" - - "migration_3x.adoc" - - "migration_4x.adoc" + - "upgrade.adoc" + - "upgrade_3x.adoc" + - "upgrade_4x.adoc" - "maven-build.adoc" - "gradle-build.adoc" - "graalnative.adoc"