From 9bbf20937d90bd415fb3c9205c51f5b332a59a22 Mon Sep 17 00:00:00 2001 From: Joe Di Pol Date: Wed, 10 Jan 2024 13:32:17 -0800 Subject: [PATCH] Fix more links --- docs/src/main/asciidoc/guides/jib.adoc | 6 +++--- docs/src/main/asciidoc/includes/openapi/openapi.adoc | 6 +++--- docs/src/main/asciidoc/mp/guides/mp-tutorial.adoc | 7 +++---- docs/src/main/asciidoc/mp/guides/upgrade_4x.adoc | 6 +++--- docs/src/main/asciidoc/mp/metrics/metrics.adoc | 4 ++-- docs/src/main/asciidoc/mp/persistence.adoc | 8 ++++---- docs/src/main/asciidoc/mp/testing-ng.adoc | 4 ++-- docs/src/main/asciidoc/se/guides/tracing.adoc | 5 +++-- 8 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/src/main/asciidoc/guides/jib.adoc b/docs/src/main/asciidoc/guides/jib.adoc index 5e981de252e..eb9ba05790f 100644 --- a/docs/src/main/asciidoc/guides/jib.adoc +++ b/docs/src/main/asciidoc/guides/jib.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. @@ -96,7 +96,7 @@ Add the following plugin declaration to your pom.xml: NOTE: By default, Jib uses link:https://github.com/GoogleContainerTools/distroless/tree/master/java[distroless/java] as the base image. You can override the default with configuration see the - link:{jib-base-url}/jib-maven-plugin/README.md#extended-usage[documentation] + link:{jib-base-url}/README.md#extended-usage[documentation] [source,bash] .Package the updated application @@ -128,6 +128,6 @@ REPOSITORY TAG IMAGE ID CREATED SIZE jib-quickstart-se latest 384aebda5594 48 years ago 124MB <1> ---- <1> Ignore the fact that it says the image was created 48 years ago. Refer to - the link:{jib-base-url}/docs/faq.md#why-is-my-image-created-48-years-ago[Jib FAQ] for explanations. + the link:{jib-base-url}/../docs/faq.md#why-is-my-image-created-48-years-ago[Jib FAQ] for explanations. NOTE: the Jib image is smaller because of the use of a distroless base image. diff --git a/docs/src/main/asciidoc/includes/openapi/openapi.adoc b/docs/src/main/asciidoc/includes/openapi/openapi.adoc index 78666756dd0..a57aeef1d56 100644 --- a/docs/src/main/asciidoc/includes/openapi/openapi.adoc +++ b/docs/src/main/asciidoc/includes/openapi/openapi.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. @@ -184,7 +184,7 @@ A Jandex index stores information about the classes and methods in your app and what annotations they have. It allows CDI to process annotations faster during your application's start-up. -Add the link:https://github.com/smallrye/jandex/maven-plugin[Jandex maven plug-in] to the `` +Add the link:https://github.com/smallrye/jandex/tree/main/maven-plugin[Jandex maven plug-in] to the `` section of your `pom.xml`: [source,xml,subs="attributes+"] @@ -215,4 +215,4 @@ configured, might inadvertently miss information. We _strongly recommend_ using the Jandex plug-in to build the index into your app. ==== -// end::additional-building-jandex[] \ No newline at end of file +// end::additional-building-jandex[] diff --git a/docs/src/main/asciidoc/mp/guides/mp-tutorial.adoc b/docs/src/main/asciidoc/mp/guides/mp-tutorial.adoc index 3e5fa20b056..26cdcdf962e 100644 --- a/docs/src/main/asciidoc/mp/guides/mp-tutorial.adoc +++ b/docs/src/main/asciidoc/mp/guides/mp-tutorial.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. @@ -722,8 +722,7 @@ Helidon also support custom metrics. To add a new metric, annotate the below: TIP: You can find details of the available annotations in the - https://microprofile.io/project/eclipse/microprofile-metrics[MicroProfile Metrics - Specification]. +link:{microprofile-metrics-spec-url}[MicroProfile Metrics Specification] [source,java] .Updated GreetResource.java with custom metrics @@ -1154,7 +1153,7 @@ There were several links to more detailed information included in the * link:{jakarta-cdi-spec-url}[Contexts and Dependency Injection Specification] * xref:../server.adoc[Server Configuration] * xref:../config/introduction.adoc[Config] -* https://microprofile.io/project/eclipse/microprofile-metrics[MicroProfile Metrics Specification] +* link:{microprofile-metrics-spec-url}[MicroProfile Metrics Specification] * xref:metrics.adoc[Metrics Guide] * link:{microprofile-health-spec-url}##_protocol_and_wireformat[MicroProfile Health Protocol and Wireformat] * xref:../../about/kubernetes.adoc[Install Kubernetes on your desktop] diff --git a/docs/src/main/asciidoc/mp/guides/upgrade_4x.adoc b/docs/src/main/asciidoc/mp/guides/upgrade_4x.adoc index 95b8663efbf..5f09317d652 100644 --- a/docs/src/main/asciidoc/mp/guides/upgrade_4x.adoc +++ b/docs/src/main/asciidoc/mp/guides/upgrade_4x.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2023 Oracle and/or its affiliates. + Copyright (c) 2023, 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. @@ -58,7 +58,7 @@ Incompatible changes described in link:https://download.eclipse.org/microprofile * *MicroProfile Metrics {version-lib-microprofile-metrics-api}*: + -Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-metrics-5.0/microprofile-metrics-spec-5.0.html#_incompatible_changes[MicroProfile Metrics {version-lib-microprofile-metrics-api} Specification] +Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-metrics-5.0.0/microprofile-metrics-spec-5.0.0.html#_incompatible_changes[MicroProfile Metrics {version-lib-microprofile-metrics-api} Specification] * *MicroProfile OpenAPI {version-lib-microprofile-openapi-api}*: + @@ -161,4 +161,4 @@ If you use this handler in your `logging.properties` you will need to update it == Conclusion -Please proceed to xref:../introduction.adoc[Helidon MP Introduction] to find more information and documentation about each module. \ No newline at end of file +Please proceed to xref:../introduction.adoc[Helidon MP Introduction] to find more information and documentation about each module. diff --git a/docs/src/main/asciidoc/mp/metrics/metrics.adoc b/docs/src/main/asciidoc/mp/metrics/metrics.adoc index 54eddc83c85..46046db683b 100644 --- a/docs/src/main/asciidoc/mp/metrics/metrics.adoc +++ b/docs/src/main/asciidoc/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. @@ -584,4 +584,4 @@ include::{rootdir}/includes/guides/metrics.adoc[tag=k8s-and-prometheus-integrati === References link:{microprofile-metrics-spec-url}[MicroProfile Metrics specification] -link:{microprofile-metrics-javadoc-url}/org/eclipse/microprofile/metrics/package-info.html[MicroProfile Metrics API] +link:{microprofile-metrics-javadoc-url}/org/eclipse/microprofile/metrics/package-summary.html[MicroProfile Metrics API] diff --git a/docs/src/main/asciidoc/mp/persistence.adoc b/docs/src/main/asciidoc/mp/persistence.adoc index 44a8dffb954..b708540fa57 100644 --- a/docs/src/main/asciidoc/mp/persistence.adoc +++ b/docs/src/main/asciidoc/mp/persistence.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. @@ -111,7 +111,7 @@ pools: 1. https://github.com/brettwooldridge/HikariCP[HikariCP] -2. link:{oracle-ucp-doc-base-url}index.html[Oracle Universal +2. link:{oracle-ucp-doc-base-url}/index.html[Oracle Universal Connection Pool] You can choose to use either, but not both. @@ -146,7 +146,7 @@ managed] ====== Maven Coordinates (Oracle Universal Connection Pool) [[DS-UCP-Maven-Coordinates]] -To include the link:{oracle-ucp-doc-base-url}index.html[Oracle +To include the link:{oracle-ucp-doc-base-url}/index.html[Oracle Universal Connection Pool] in your Helidon MP application: * xref:../about/managing-dependencies.adoc[Ensure your dependencies are @@ -1428,7 +1428,7 @@ relational database tables, and how to perform other related tasks. * link:{jakarta-persistence-javadoc-url}/[Jakarta Persistence {persistence-lib-jakarta-persistence-api} API Reference] -* link:{hibernate-doc-jboss-url}userguide/html_single/Hibernate_User_Guide.html[Hibernate +* link:{hibernate-doc-jboss-url}/userguide/html_single/Hibernate_User_Guide.html[Hibernate ORM User Guide] * https://www.eclipse.org/eclipselink/documentation/[Eclipselink documentation] diff --git a/docs/src/main/asciidoc/mp/testing-ng.adoc b/docs/src/main/asciidoc/mp/testing-ng.adoc index d1ffb80c488..ccecc121546 100644 --- a/docs/src/main/asciidoc/mp/testing-ng.adoc +++ b/docs/src/main/asciidoc/mp/testing-ng.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. @@ -193,4 +193,4 @@ public class TestReqScopeDisabledDiscovery { == Reference -* https://testng.org/doc/documentation-main.html[TestNG User Guide] +* https://testng.org[TestNG Documentation] diff --git a/docs/src/main/asciidoc/se/guides/tracing.adoc b/docs/src/main/asciidoc/se/guides/tracing.adoc index 45a58b98f93..56af1d90668 100644 --- a/docs/src/main/asciidoc/se/guides/tracing.adoc +++ b/docs/src/main/asciidoc/se/guides/tracing.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. @@ -323,7 +323,8 @@ server: host: 0.0.0.0 ---- -NOTE: The settings above are for development and experimental purposes only. For production environment, please see the link:../tracing.adoc[Tracing documentation]. +NOTE: The settings above are for development and experimental purposes only. For production environment, please see the +xref:{rootdir}/se/tracing.adoc[Tracing documentation]. [source,java] .Update the `Main` class; Add Tracer to the WebServer builder