Skip to content

Commit

Permalink
3.x: Fixes links in documentation to point to helidon-examples repo…
Browse files Browse the repository at this point in the history
…sitory. (#9093)

* Fix links to example code
  • Loading branch information
barchetta authored Aug 2, 2024
1 parent fdc9609 commit b799893
Show file tree
Hide file tree
Showing 34 changed files with 87 additions and 87 deletions.
4 changes: 2 additions & 2 deletions docs/includes/cors.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/guides/gradle-build.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/guides/metrics.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/includes/metrics/metrics-shared.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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[]
4 changes: 2 additions & 2 deletions docs/includes/metrics/micrometer-shared.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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[]
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/metrics/prometheus-exemplar-support.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/openapi.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/openapi/openapi.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/security/providers/abac.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/security/providers/google-login.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/security/providers/idcs-role-mapper.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/security/providers/jwt.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/security/providers/oidc.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/mp/cors/cors.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions docs/mp/grpc/client.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
6 changes: 3 additions & 3 deletions docs/mp/grpc/server.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
8 changes: 4 additions & 4 deletions docs/mp/health.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/mp/integrations/hcv.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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]
* link:{helidon-github-examples-url}/integrations/vault[Hashicorp Vault Usage Examples]
4 changes: 2 additions & 2 deletions docs/mp/integrations/jedis.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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]
4 changes: 2 additions & 2 deletions docs/mp/integrations/oci.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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]
4 changes: 2 additions & 2 deletions docs/mp/metrics/metrics.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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:
Expand Down
Loading

0 comments on commit b799893

Please sign in to comment.