From b79989312c0ed4bd700d981dbf2b51653f487b6f Mon Sep 17 00:00:00 2001 From: Joe DiPol Date: Fri, 2 Aug 2024 13:37:23 -0700 Subject: [PATCH] 3.x: Fixes links in documentation to point to `helidon-examples` repository. (#9093) * Fix links to example code --- docs/includes/cors.adoc | 4 ++-- docs/includes/guides/gradle-build.adoc | 4 ++-- docs/includes/guides/metrics.adoc | 4 ++-- docs/includes/metrics/metrics-shared.adoc | 6 +++--- docs/includes/metrics/micrometer-shared.adoc | 4 ++-- .../metrics/prometheus-exemplar-support.adoc | 4 ++-- docs/includes/openapi.adoc | 4 ++-- docs/includes/openapi/openapi.adoc | 4 ++-- docs/includes/security/providers/abac.adoc | 4 ++-- docs/includes/security/providers/google-login.adoc | 4 ++-- .../security/providers/idcs-role-mapper.adoc | 4 ++-- docs/includes/security/providers/jwt.adoc | 4 ++-- docs/includes/security/providers/oidc.adoc | 4 ++-- docs/mp/cors/cors.adoc | 6 +++--- docs/mp/grpc/client.adoc | 8 ++++---- docs/mp/grpc/server.adoc | 6 +++--- docs/mp/health.adoc | 8 ++++---- docs/mp/integrations/hcv.adoc | 4 ++-- docs/mp/integrations/jedis.adoc | 4 ++-- docs/mp/integrations/oci.adoc | 4 ++-- docs/mp/metrics/metrics.adoc | 4 ++-- docs/mp/openapi.adoc | 4 ++-- docs/mp/openapi/openapi.adoc | 4 ++-- docs/mp/reactivemessaging/kafka.adoc | 4 ++-- docs/mp/websocket.adoc | 4 ++-- docs/se/cors.adoc | 8 ++++---- docs/se/dbclient.adoc | 4 ++-- docs/se/grpc/client.adoc | 14 +++++++------- docs/se/grpc/server.adoc | 14 +++++++------- docs/se/integrations/hcv.adoc | 4 ++-- docs/se/integrations/oci.adoc | 4 ++-- docs/se/openapi/openapi.adoc | 4 ++-- docs/se/reactive-messaging.adoc | 2 +- docs/se/websocket.adoc | 6 +++--- 34 files changed, 87 insertions(+), 87 deletions(-) diff --git a/docs/includes/cors.adoc b/docs/includes/cors.adoc index 4e17175ab32..5eba4c41dbb 100644 --- a/docs/includes/cors.adoc +++ b/docs/includes/cors.adoc @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2022 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -315,7 +315,7 @@ application's configuration file, the configuration for each service appears und | xref:{openapi-page}[OpenAPI] | `openapi` |==== -The link:{helidon-github-tree-url}/examples/quickstarts/helidon-quickstart-{flavor-lc}[Helidon {flavor-uc} QuickStart example] +The link:{helidon-github-examples-url}/quickstarts/helidon-quickstart-{flavor-lc}[Helidon {flavor-uc} QuickStart example] uses these services, so you can use that as a template for your own application, or use the example project itself to experiment with customizing the CORS behavior in the built-in services. diff --git a/docs/includes/guides/gradle-build.adoc b/docs/includes/guides/gradle-build.adoc index 5f48b166e35..f81140c57d4 100644 --- a/docs/includes/guides/gradle-build.adoc +++ b/docs/includes/guides/gradle-build.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2022 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -26,7 +26,7 @@ with a Gradle project. We recommend Gradle 6+. == Gradle Example The Helidon -link:{helidon-github-tree-url}/examples/quickstarts/helidon-quickstart-{flavor-lc}[Quickstart Example] +link:{helidon-github-examples-url}/quickstarts/helidon-quickstart-{flavor-lc}[Quickstart Example] contains a `build.gradle` file that you can use as an example for building your Helidon application using Gradle. diff --git a/docs/includes/guides/metrics.adoc b/docs/includes/guides/metrics.adoc index 0339f348a20..f620f939ea4 100644 --- a/docs/includes/guides/metrics.adoc +++ b/docs/includes/guides/metrics.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2023 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -193,7 +193,7 @@ The `vendor` metrics shown above appear in two groups: - Helidon thread pools + + -Helidon uses these thread pools for its own internal work, and your application can also use Helidon-managed thread pools if it needs to do work asynchronously. (See link:{helidon-github-tree-url}/examples/webserver/threadpool[this example].) +Helidon uses these thread pools for its own internal work, and your application can also use Helidon-managed thread pools if it needs to do work asynchronously. (See link:{helidon-github-examples-url}/webserver/threadpool[this example].) The metrics in this group show information about the thread pools which can help you assess how efficiently they are utilized. Helidon uses tags to distinguish the metrics which describe different thread pools. In some cases the specific metrics exposed depend on the particular type of thread pool. diff --git a/docs/includes/metrics/metrics-shared.adoc b/docs/includes/metrics/metrics-shared.adoc index 2d836f13f59..67bfb4395c9 100644 --- a/docs/includes/metrics/metrics-shared.adoc +++ b/docs/includes/metrics/metrics-shared.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2023 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -161,11 +161,11 @@ The `MetricRegistry` allows your code to register new metrics, look up previousl // tag::example-apps[] Helidon {flavor-uc} includes several prewritten example applications illustrating aspects of metrics: -* link:{helidon-github-tree-url}/examples/metrics/filtering/{flavor-lc}[Enabling/disabling metrics] using +* link:{helidon-github-examples-url}/metrics/filtering/{flavor-lc}[Enabling/disabling metrics] using ifdef::se-flavor[`MetricsSettings`] ifdef::mp-flavor[configuration] ifdef::se-flavor[] -* link:{helidon-github-tree-url}/examples/metrics/kpi[Controlling key performance indicator metrics] using configuration and `KeyPerformanceIndicatorMetricsSettings`. +* link:{helidon-github-examples-url}/metrics/kpi[Controlling key performance indicator metrics] using configuration and `KeyPerformanceIndicatorMetricsSettings`. endif::[] // end::example-apps[] \ No newline at end of file diff --git a/docs/includes/metrics/micrometer-shared.adoc b/docs/includes/metrics/micrometer-shared.adoc index ff6553f78f0..b7b197cf75c 100644 --- a/docs/includes/metrics/micrometer-shared.adoc +++ b/docs/includes/metrics/micrometer-shared.adoc @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2023 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -187,7 +187,7 @@ can create, look up, and update metrics programmatically using the Micrometer `M // end::use-micrometer-api[] // tag::example-apps[] -Helidon {flavor-uc} includes an link:{helidon-github-tree-url}/examples/integrations/micrometer/{flavor-lc}[example application] which uses Micrometer support. +Helidon {flavor-uc} includes an link:{helidon-github-examples-url}/integrations/micrometer/{flavor-lc}[example application] which uses Micrometer support. // end::example-apps[] // end::all-micrometer[] diff --git a/docs/includes/metrics/prometheus-exemplar-support.adoc b/docs/includes/metrics/prometheus-exemplar-support.adoc index 15267d74747..ac86b0f3ae7 100644 --- a/docs/includes/metrics/prometheus-exemplar-support.adoc +++ b/docs/includes/metrics/prometheus-exemplar-support.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2023 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -151,7 +151,7 @@ endif::[] == Examples ifdef::se-flavor[] -Helidon includes an link:{helidon-github-tree-url}/examples/metrics/exemplar[example application], based on the QuickStart application, which illustrates exemplar support. +Helidon includes an link:{helidon-github-examples-url}/metrics/exemplar[example application], based on the QuickStart application, which illustrates exemplar support. endif::[] Once you enable exemplar support you can see the exemplars in the metrics output. diff --git a/docs/includes/openapi.adoc b/docs/includes/openapi.adoc index e0a7952378f..82270b4209e 100644 --- a/docs/includes/openapi.adoc +++ b/docs/includes/openapi.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2022 Oracle and/or its affiliates. + Copyright (c) 2022, 2024 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. @@ -90,7 +90,7 @@ You can also define any request parameters the endpoint expects, although this endpoint uses none. This excerpt shows only a few annotations for illustration. The -link:{helidon-github-tree-url}/examples/microprofile/openapi-basic[Helidon MP OpenAPI example] illustrates more, +link:{helidon-github-examples-url}/microprofile/openapi-basic[Helidon MP OpenAPI example] illustrates more, and the link:{microprofile-open-api-spec-url}[MicroProfile OpenAPI spec] describes them all. ===== Provide a static OpenAPI file diff --git a/docs/includes/openapi/openapi.adoc b/docs/includes/openapi/openapi.adoc index fd2c8daac03..97ed53374bc 100644 --- a/docs/includes/openapi/openapi.adoc +++ b/docs/includes/openapi/openapi.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2022 Oracle and/or its affiliates. + Copyright (c) 2022, 2024 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. @@ -98,7 +98,7 @@ You can also define any request parameters the endpoint expects, although this endpoint uses none. This excerpt shows only a few annotations for illustration. The -link:{helidon-github-tree-url}/examples/microprofile/openapi-basic[Helidon MP OpenAPI example] illustrates more, +link:{helidon-github-examples-url}/microprofile/openapi-basic[Helidon MP OpenAPI example] illustrates more, and the link:{microprofile-open-api-spec-url}[MicroProfile OpenAPI spec] describes them all. ===== Provide a static OpenAPI file diff --git a/docs/includes/security/providers/abac.adoc b/docs/includes/security/providers/abac.adoc index 43a319aa33c..f89133b1d3e 100644 --- a/docs/includes/security/providers/abac.adoc +++ b/docs/includes/security/providers/abac.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2023 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -51,7 +51,7 @@ include::{rootdir}/config/io_helidon_security_providers_abac_AbacProvider.adoc[l === Examples [[ABAC-Provider-Examples]] -See the link:{helidon-github-tree-url}/examples/security/attribute-based-access-control[example] on GitHub. +See the link:{helidon-github-examples-url}/security/attribute-based-access-control[example] on GitHub. [source,yaml] .Configuration example diff --git a/docs/includes/security/providers/google-login.adoc b/docs/includes/security/providers/google-login.adoc index ed0c41c3725..10f977370d7 100644 --- a/docs/includes/security/providers/google-login.adoc +++ b/docs/includes/security/providers/google-login.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2023 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -47,7 +47,7 @@ include::{rootdir}/config/io_helidon_security_providers_google_login_GoogleToken === Example Code [[Google-Provider-Example]] -See the link:{helidon-github-tree-url}/examples/security/google-login[example] on GitHub. +See the link:{helidon-github-examples-url}/security/google-login[example] on GitHub. [source,yaml] .Configuration example diff --git a/docs/includes/security/providers/idcs-role-mapper.adoc b/docs/includes/security/providers/idcs-role-mapper.adoc index 463689e6d4e..b07e2eb6967 100644 --- a/docs/includes/security/providers/idcs-role-mapper.adoc +++ b/docs/includes/security/providers/idcs-role-mapper.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2022 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -46,7 +46,7 @@ include::{rootdir}/config/io_helidon_security_providers_idcs_mapper_IdcsMtRoleMa ==== Example code -See the link:{helidon-github-tree-url}/examples/security/idcs-login/[example] on GitHub. +See the link:{helidon-github-examples-url}/security/idcs-login/[example] on GitHub. [source,yaml] .Configuration example diff --git a/docs/includes/security/providers/jwt.adoc b/docs/includes/security/providers/jwt.adoc index 066c006bfae..a51dcb8434f 100644 --- a/docs/includes/security/providers/jwt.adoc +++ b/docs/includes/security/providers/jwt.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2023 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -47,7 +47,7 @@ include::{rootdir}/config/io_helidon_security_providers_jwt_JwtProvider.adoc[lev === Example Code [[JWT-Provider-Example]] -See the link:{helidon-github-tree-url}/examples/security/outbound-override[example] on GitHub. +See the link:{helidon-github-examples-url}/security/outbound-override[example] on GitHub. [source,yaml] .Configuration example diff --git a/docs/includes/security/providers/oidc.adoc b/docs/includes/security/providers/oidc.adoc index 9489ea19af0..a69e82ee02f 100644 --- a/docs/includes/security/providers/oidc.adoc +++ b/docs/includes/security/providers/oidc.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2018, 2023 Oracle and/or its affiliates. + Copyright (c) 2018, 2024 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. @@ -26,7 +26,7 @@ ifndef::rootdir[:rootdir: {docdir}/../../..] include::{rootdir}/config/io_helidon_security_providers_oidc_OidcProvider.adoc[leveloffset=+2,tag=config] === Example Code [[OIDC-Provider-Example]] -See the link:{helidon-github-tree-url}/examples/security/idcs-login[example] on GitHub. +See the link:{helidon-github-examples-url}/security/idcs-login[example] on GitHub. [source,yaml] .Configuration example diff --git a/docs/mp/cors/cors.adoc b/docs/mp/cors/cors.adoc index 3de19376a55..b31da43c934 100644 --- a/docs/mp/cors/cors.adoc +++ b/docs/mp/cors/cors.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2022 Oracle and/or its affiliates. + Copyright (c) 2022, 2024 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. @@ -132,12 +132,12 @@ include::{rootdir}/includes/cors.adoc[tag=cors-config-table] == Examples -The link:{helidon-github-tree-url}/examples/quickstarts/helidon-quickstart-mp[Helidon MP Quickstart application] allows users to: +The link:{helidon-github-examples-url}/quickstarts/helidon-quickstart-mp[Helidon MP Quickstart application] allows users to: * obtain greetings by sending `GET` requests to the `/greet` resource, and * change the greeting message by sending a `PUT` request to the `/greet/greeting` resource. -The link:{helidon-github-tree-url}/examples/microprofile/cors[Helidon MP CORS Example] shows the basic quickstart example enhanced for CORS. +The link:{helidon-github-examples-url}/microprofile/cors[Helidon MP CORS Example] shows the basic quickstart example enhanced for CORS. The discussion below describes the changes in the application which: diff --git a/docs/mp/grpc/client.adoc b/docs/mp/grpc/client.adoc index 31dfa2332ca..36e88bebef2 100644 --- a/docs/mp/grpc/client.adoc +++ b/docs/mp/grpc/client.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2019, 2023 Oracle and/or its affiliates. + Copyright (c) 2019, 2024 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. @@ -283,8 +283,8 @@ public interface StringService { ---- == Examples -link:{helidon-github-tree-url}/examples/grpc/microprofile/basic-client[Basic gRPC Client] example demonstrates a +link:{helidon-github-examples-url}/grpc/microprofile/basic-client[Basic gRPC Client] example demonstrates a simple gRPC client that invokes services from deployed gRPC server applications provided in the -link:{helidon-github-tree-url}/examples/grpc/microprofile/basic-server-implicit[Basic gRPC Server] and -link:{helidon-github-tree-url}/examples/grpc/microprofile/metrics[gRPC Server metrics] examples. +link:{helidon-github-examples-url}/grpc/microprofile/basic-server-implicit[Basic gRPC Server] and +link:{helidon-github-examples-url}/grpc/microprofile/metrics[gRPC Server metrics] examples. diff --git a/docs/mp/grpc/server.adoc b/docs/mp/grpc/server.adoc index 8511b0343a0..087be04e289 100644 --- a/docs/mp/grpc/server.adoc +++ b/docs/mp/grpc/server.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2019, 2023 Oracle and/or its affiliates. + Copyright (c) 2019, 2024 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. @@ -362,9 +362,9 @@ grpc: == Examples Helidon MP includes some examples that demonstrate the gRPC server usage: -* link:{helidon-github-tree-url}/examples/grpc/microprofile/basic-server-implicit[Basic gRPC Server example] provides +* link:{helidon-github-examples-url}/grpc/microprofile/basic-server-implicit[Basic gRPC Server example] provides a simple gRPC application that deploys a gRPC service that will be discovered by CDI. Two additional services are included that are not normally CDI managed beans, but are manually added as CDI managed beans so that they can also be discovered by Helidon MP. -* link:{helidon-github-tree-url}/examples/grpc/microprofile/metrics[gRPC Server Metrics example] demonstrates a +* link:{helidon-github-examples-url}/grpc/microprofile/metrics[gRPC Server Metrics example] demonstrates a Helidon MP application that enables `metrics` and `tracing` on a gRPC Service. diff --git a/docs/mp/health.adoc b/docs/mp/health.adoc index 8598e8c0427..338a810a01e 100644 --- a/docs/mp/health.adoc +++ b/docs/mp/health.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2023 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -288,7 +288,7 @@ curl http://localhost:8080/health/live } ---- -Full example code is available link:{helidon-github-tree-url}/examples/microprofile[here]. +Full example code is available link:{helidon-github-examples-url}/microprofile[here]. === Custom Readiness Health Checks @@ -387,7 +387,7 @@ curl -v http://localhost:8080/health/ready } ---- -Full example code is available link:{helidon-github-tree-url}/examples/microprofile[here]. +Full example code is available link:{helidon-github-examples-url}/microprofile[here]. === Custom Startup Health Checks @@ -517,7 +517,7 @@ curl http://localhost:8080/health } ---- -Full example code is available link:{helidon-github-tree-url}/examples/microprofile[here]. +Full example code is available link:{helidon-github-examples-url}/microprofile[here]. == Reference diff --git a/docs/mp/integrations/hcv.adoc b/docs/mp/integrations/hcv.adoc index b161b0b3b05..ebb19702752 100644 --- a/docs/mp/integrations/hcv.adoc +++ b/docs/mp/integrations/hcv.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2023 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -534,4 +534,4 @@ This will create a Vault docker image, run it in background and open it on `loca == References -* link:{helidon-github-tree-url}/examples/integrations/vault[Hashicorp Vault Usage Examples] \ No newline at end of file +* link:{helidon-github-examples-url}/integrations/vault[Hashicorp Vault Usage Examples] \ No newline at end of file diff --git a/docs/mp/integrations/jedis.adoc b/docs/mp/integrations/jedis.adoc index 128b16d9c06..301baf68636 100644 --- a/docs/mp/integrations/jedis.adoc +++ b/docs/mp/integrations/jedis.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2023 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -176,7 +176,7 @@ with `redis.clients.jedis.JedisPoolConfig.default` and `redis.clients.jedis.Jedi == References -* link:{helidon-github-tree-url}/examples/integrations/cdi/jedis[Helidon Jedis Example] +* link:{helidon-github-examples-url}/integrations/cdi/jedis[Helidon Jedis Example] * link:{jedis-base-url}/jedis/package-summary.html[Jedis Javadoc] * link:https://github.com/xetorthio/jedis[Jedis] * link:https://github.com/redis/redis[Redis] \ No newline at end of file diff --git a/docs/mp/integrations/oci.adoc b/docs/mp/integrations/oci.adoc index 40f12f1af25..df1851d4ce3 100644 --- a/docs/mp/integrations/oci.adoc +++ b/docs/mp/integrations/oci.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2023 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -142,4 +142,4 @@ Once you have injected an ObjectStorage client you can use it as described in: == References * link:{integration-oci-sdk-cdi-javadoc-base-url}/io/helidon/integrations/oci/sdk/cdi/OciExtension.html[OciExtension] Javadocs -* link:{helidon-github-tree-url}/examples/integrations/oci[OCI SDK Usage Examples] +* link:{helidon-github-examples-url}/integrations/oci[OCI SDK Usage Examples] diff --git a/docs/mp/metrics/metrics.adoc b/docs/mp/metrics/metrics.adoc index 6307eab7800..bdabbebd49d 100644 --- a/docs/mp/metrics/metrics.adoc +++ b/docs/mp/metrics/metrics.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2022, 2023 Oracle and/or its affiliates. + Copyright (c) 2022, 2024 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. @@ -136,7 +136,7 @@ include::{rootdir}/includes/metrics/metrics-config.adoc[tag=config-intro] == Examples Helidon MP includes a prewritten example application illustrating -link:{helidon-github-tree-url}/examples/metrics/filtering/mp[enabling/disabling metrics] using configuration. +link:{helidon-github-examples-url}/metrics/filtering/mp[enabling/disabling metrics] using configuration. The rest of this section contains other examples of working with metrics: diff --git a/docs/mp/openapi.adoc b/docs/mp/openapi.adoc index b14bb428a46..e9891d603e2 100644 --- a/docs/mp/openapi.adoc +++ b/docs/mp/openapi.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2019, 2023 Oracle and/or its affiliates. + Copyright (c) 2019, 2024 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. @@ -95,7 +95,7 @@ include::{rootdir}/config/io_helidon_microprofile_openapi_MPOpenAPISupport.adoc[ == Examples -Helidon MP includes a link:{helidon-github-tree-url}/examples/microprofile/openapi-basic[complete OpenAPI example] +Helidon MP includes a link:{helidon-github-examples-url}/microprofile/openapi-basic[complete OpenAPI example] based on the MP quick-start sample app. The rest of this section shows, step-by-step, how one might change the original QuickStart service to adopt OpenAPI. === Helidon MP Basic OpenAPI Example diff --git a/docs/mp/openapi/openapi.adoc b/docs/mp/openapi/openapi.adoc index d418130b491..9e0cc4c55fd 100644 --- a/docs/mp/openapi/openapi.adoc +++ b/docs/mp/openapi/openapi.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2019, 2023 Oracle and/or its affiliates. + Copyright (c) 2019, 2024 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. @@ -92,7 +92,7 @@ include::{rootdir}/config/io_helidon_microprofile_openapi_MPOpenAPISupport.adoc[ == Examples -Helidon MP includes a link:{helidon-github-tree-url}/examples/microprofile/openapi-basic[complete OpenAPI example] +Helidon MP includes a link:{helidon-github-examples-url}/microprofile/openapi-basic[complete OpenAPI example] based on the MP quick-start sample app. The rest of this section shows, step-by-step, how one might change the original QuickStart service to adopt OpenAPI. === Helidon MP Basic OpenAPI Example diff --git a/docs/mp/reactivemessaging/kafka.adoc b/docs/mp/reactivemessaging/kafka.adoc index 84fc198216f..835b589a463 100644 --- a/docs/mp/reactivemessaging/kafka.adoc +++ b/docs/mp/reactivemessaging/kafka.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2022 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -163,4 +163,4 @@ mp.messaging: Don't forget to check out the examples with pre-configured Kafka docker image, for easy testing: -* {helidon-github-tree-url}/examples/messaging \ No newline at end of file +* {helidon-github-examples-url}/messaging \ No newline at end of file diff --git a/docs/mp/websocket.adoc b/docs/mp/websocket.adoc index 8d944ea0620..908cfc6a0b9 100644 --- a/docs/mp/websocket.adoc +++ b/docs/mp/websocket.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2023 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -172,7 +172,7 @@ the root path for WebSocket endpoints will be `"/web"` instead of the default ` All endpoint methods in Helidon MP are executed in a separate thread pool, independently of Netty. Therefore, there is no need to create additional threads for blocking or long-running operations as these will not affect Netty's ability to process networking data. -For more information see the link:{helidon-github-tree-url}/examples/webserver/websocket[example]. +For more information see the link:{helidon-github-examples-url}/webserver/websocket[example]. === WebSocket Endpoints on Different Ports diff --git a/docs/se/cors.adoc b/docs/se/cors.adoc index 202f1c82fa8..eb7c84d98cd 100644 --- a/docs/se/cors.adoc +++ b/docs/se/cors.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2022 Oracle and/or its affiliates. + Copyright (c) 2022, 2024 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. @@ -100,7 +100,7 @@ include::{rootdir}/includes/cors.adoc[tag=cors-config-table] [[se-api-routing-example]] === Sample Routing Setup Using the `CrossOriginConfig` API -The link:{helidon-github-tree-url}/examples/quickstarts/helidon-quickstart-se[Helidon SE Quickstart application] +The link:{helidon-github-examples-url}/quickstarts/helidon-quickstart-se[Helidon SE Quickstart application] lets you change the greeting by sending a `PUT` request to the `/greet/greeting` resource. This example, based on the QuickStart greeting app, uses the low-level `CrossOriginConfig` API and @@ -243,7 +243,7 @@ rebuild and restart your application for any changes to take effect. == Examples -For a complete example, see {helidon-github-tree-url}/examples/cors[Helidon SE CORS Example]. +For a complete example, see {helidon-github-examples-url}/cors[Helidon SE CORS Example]. == Additional Information @@ -266,7 +266,7 @@ service type has a `Builder` class. To control the CORS behavior of a built-in s . Use the service instance in preparing the routing rules. The following excerpt shows changes to the - link:{helidon-github-tree-url}/examples/quickstarts/helidon-quickstart-se[Helidon SE QuickStart example] which limit + link:{helidon-github-examples-url}/quickstarts/helidon-quickstart-se[Helidon SE QuickStart example] which limit sharing of the `/metrics` endpoint to `\http://foo.com`. [source,java] diff --git a/docs/se/dbclient.adoc b/docs/se/dbclient.adoc index fa89864afa1..0c0a0e4ecab 100644 --- a/docs/se/dbclient.adoc +++ b/docs/se/dbclient.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2022 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -305,7 +305,7 @@ Execution of a query statement will always return `Multi>`. `Multi` has s == Additional Information Now that you understand how to build and execute statements, try it for yourself. -link:{helidon-github-tree-url}/examples/dbclient[DB Client Examples]. +link:{helidon-github-examples-url}/dbclient[DB Client Examples]. diff --git a/docs/se/grpc/client.adoc b/docs/se/grpc/client.adoc index 8a09591fd27..be18367c0e8 100644 --- a/docs/se/grpc/client.adoc +++ b/docs/se/grpc/client.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2019, 2023 Oracle and/or its affiliates. + Copyright (c) 2019, 2024 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. @@ -553,10 +553,10 @@ a client that can be used to define the set of methods described by the specifie === Additional gRPC Client Examples A set of gRPC client examples for Helidon SE can be found in the following links: -* link:{helidon-github-tree-url}/examples/grpc/client-standalone[Basic gRPC Standalone Client] -* link:{helidon-github-tree-url}/examples/grpc/metrics[gRPC Server Metrics] -* link:{helidon-github-tree-url}/examples/grpc/opentracing[OpenTracing on a gRPC Server] -* link:{helidon-github-tree-url}/examples/grpc/security[Basic Auth Security on a gRPC Server] -* link:{helidon-github-tree-url}/examples/grpc/security-abac[Attribute-Based Access Control (ABAC) security on a gRPC Server] -* link:{helidon-github-tree-url}/examples/grpc/security-outbound[Outbound Security on a gRPC Server] +* link:{helidon-github-examples-url}/grpc/client-standalone[Basic gRPC Standalone Client] +* link:{helidon-github-examples-url}/grpc/metrics[gRPC Server Metrics] +* link:{helidon-github-examples-url}/grpc/opentracing[OpenTracing on a gRPC Server] +* link:{helidon-github-examples-url}/grpc/security[Basic Auth Security on a gRPC Server] +* link:{helidon-github-examples-url}/grpc/security-abac[Attribute-Based Access Control (ABAC) security on a gRPC Server] +* link:{helidon-github-examples-url}/grpc/security-outbound[Outbound Security on a gRPC Server] diff --git a/docs/se/grpc/server.adoc b/docs/se/grpc/server.adoc index 461505253b0..3f4794fc1fb 100644 --- a/docs/se/grpc/server.adoc +++ b/docs/se/grpc/server.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2019, 2023 Oracle and/or its affiliates. + Copyright (c) 2019, 2024 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. @@ -948,10 +948,10 @@ static class HelloService implements GrpcService { // <5> === Additional gRPC Server Examples A set of gRPC server examples for Helidon SE can be found in the following links: -* link:{helidon-github-tree-url}/examples/grpc/basics[Basic gRPC Server] -* link:{helidon-github-tree-url}/examples/grpc/metrics[gRPC Server Metrics] -* link:{helidon-github-tree-url}/examples/grpc/opentracing[OpenTracing on a gRPC Server] -* link:{helidon-github-tree-url}/examples/grpc/security[Basic Auth Security on a gRPC Server] -* link:{helidon-github-tree-url}/examples/grpc/security-abac[Attribute-Based Access Control (ABAC) security on a gRPC Server] -* link:{helidon-github-tree-url}/examples/grpc/security-outbound[Outbound Security on a gRPC Server] +* link:{helidon-github-examples-url}/grpc/basics[Basic gRPC Server] +* link:{helidon-github-examples-url}/grpc/metrics[gRPC Server Metrics] +* link:{helidon-github-examples-url}/grpc/opentracing[OpenTracing on a gRPC Server] +* link:{helidon-github-examples-url}/grpc/security[Basic Auth Security on a gRPC Server] +* link:{helidon-github-examples-url}/grpc/security-abac[Attribute-Based Access Control (ABAC) security on a gRPC Server] +* link:{helidon-github-examples-url}/grpc/security-outbound[Outbound Security on a gRPC Server] diff --git a/docs/se/integrations/hcv.adoc b/docs/se/integrations/hcv.adoc index 5a04b3fedc7..d5084d9169a 100644 --- a/docs/se/integrations/hcv.adoc +++ b/docs/se/integrations/hcv.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2022 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -575,4 +575,4 @@ This will create a Vault docker image, run it in background and open it on local == References -* link:{helidon-github-tree-url}/examples/integrations/vault[Hashicorp Vault Usage Examples] \ No newline at end of file +* link:{helidon-github-examples-url}/integrations/vault[Hashicorp Vault Usage Examples] \ No newline at end of file diff --git a/docs/se/integrations/oci.adoc b/docs/se/integrations/oci.adoc index 052e5a1e9b4..b7df8aff6d4 100644 --- a/docs/se/integrations/oci.adoc +++ b/docs/se/integrations/oci.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2021, 2022 Oracle and/or its affiliates. + Copyright (c) 2021, 2024 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. @@ -109,6 +109,6 @@ Once you have created an ObjectStorage client you can use it as described in: == References -* link:{helidon-github-tree-url}/examples/integrations/oci[OCI SDK Usage Examples] +* link:{helidon-github-examples-url}/integrations/oci[OCI SDK Usage Examples] * link:https://docs.oracle.com/en-us/iaas/Content/home.htm[OCI Documentation] ] diff --git a/docs/se/openapi/openapi.adoc b/docs/se/openapi/openapi.adoc index fde300d27bb..c9044a85558 100644 --- a/docs/se/openapi/openapi.adoc +++ b/docs/se/openapi/openapi.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2019, 2022 Oracle and/or its affiliates. + Copyright (c) 2019, 2024 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. @@ -98,7 +98,7 @@ include::{rootdir}/config/io_helidon_openapi_SEOpenAPISupport.adoc[leveloffset=+ == Examples -Helidon SE provides a link:{helidon-github-tree-url}/examples/openapi[complete OpenAPI example] +Helidon SE provides a link:{helidon-github-examples-url}/openapi[complete OpenAPI example] based on the SE QuickStart sample app which includes a model reader and a filter. Most Helidon {flavor-uc} applications need only to create and register `OpenAPISupport`. diff --git a/docs/se/reactive-messaging.adoc b/docs/se/reactive-messaging.adoc index d8926bcd8e0..1df2c6040c0 100644 --- a/docs/se/reactive-messaging.adoc +++ b/docs/se/reactive-messaging.adoc @@ -694,4 +694,4 @@ Messaging.builder()<5> * link:{microprofile-reactive-messaging-spec-url}[MicroProfile Reactive Messaging Specification] * link:https://github.com/eclipse/microprofile-reactive-messaging[MicroProfile Reactive Messaging on GitHub] -* link:{helidon-github-tree-url}/examples/messaging[Helidon Messaging Examples] \ No newline at end of file +* link:{helidon-github-examples-url}/messaging[Helidon Messaging Examples] \ No newline at end of file diff --git a/docs/se/websocket.adoc b/docs/se/websocket.adoc index 80e5e7862e4..9a143b1605e 100644 --- a/docs/se/websocket.adoc +++ b/docs/se/websocket.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2022 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 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. @@ -68,7 +68,7 @@ one at a time, over a connection. The example will show how REST and WebSocket connections can be seamlessly combined into a Helidon application. -The complete Helidon SE example is available {helidon-github-tree-url}/examples/webserver/websocket[here]. Let us start by +The complete Helidon SE example is available {helidon-github-examples-url}/webserver/websocket[here]. Let us start by looking at `MessageQueueService`: [source,java] @@ -162,7 +162,7 @@ This code snippet uses multiple builders for `Routing`, `WebSocketRouting` and ` In particular, it registers `MessageBoardEndpoint.class` at `"/websocket/board"` and associates with it a _message encoder_. For more information on message encoders and decoders the reader see the {jakarta-websocket-spec-url}[websocket specification]; in this - {helidon-github-tree-url}/examples/webserver/websocket[example], `UppercaseEncoder.class` simply uppercases every + {helidon-github-examples-url}/webserver/websocket[example], `UppercaseEncoder.class` simply uppercases every message sent from the server. Endpoint methods in Helidon SE are executed in Netty's worker thread pool. Threads in this