Skip to content

Commit

Permalink
4.x: fix broken documentation links Part 1 (#8219)
Browse files Browse the repository at this point in the history
* Fix links. First pass.
  • Loading branch information
barchetta authored Jan 10, 2024
1 parent 13b4ef0 commit c1a744f
Show file tree
Hide file tree
Showing 14 changed files with 48 additions and 48 deletions.
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/guides/jib.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 Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
28 changes: 14 additions & 14 deletions docs/src/main/asciidoc/includes/attributes.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 @@ -49,31 +49,31 @@ endif::[]
:version-lib-microprofile-metrics-api: 5.0.1
:version-lib-microprofile-openapi-api: 3.1
:version-lib-microprofile-reactive-messaging-api: 3.0
:version-lib-microprofile-rs-operators-api: 3.1.1
:version-lib-microprofile-rs-operators-api: 3.0
:version-lib-microprofile-rest-client: 3.0
:version.lib.microprofile-telemetry-tck: 1.0
:version-lib-microprofile-telemetry: 1.0
:version-lib-microprofile-tracing: 3.0
// jakarta specifications
:version-lib-jakarta-core: 10
:version-lib-jakarta-cdi: 4.0.1
:version-lib-jakarta-websockets-api: 2.1.0
:version-lib-jakarta-cdi: 4.0
:version-lib-jakarta-websockets-api: 2.1
:version-lib-jakarta-bean-validation: 3.0
:version-lib-jakarta-jsonp-api: 2.1.1
:version-lib-jakarta-jsonp-api: 2.1
:version-lib-jakarta-jsonb-api: 3.0
:version-lib-jakarta-jsonp-api: 2.1.1
:version-lib-jakarta-jsonp-api: 2.1
:version-lib-jakarta-annotations-api: 2.1.1
:version-lib-jakarta-transaction-api: 2.0
:version-lib-jakarta-persistence-api: 3.1.0
:version-lib-jakarta-jaxrs-api: 3.1.0
:version-lib-jakarta-inject: 2.0.1
:version-lib-jakarta-persistence-api: 3.1
:version-lib-jakarta-jaxrs-api: 3.1
:version-lib-jakarta-inject: 2.0
// 3rd party
:version-lib-jaeger: 1.22
:version-lib-hikaricp: 5.0.1
:version-lib-eclipselink: 4.0.2
:version-lib-hibernate: 6.1.7.Final
:version-lib-hibernate: 6.1
:version-lib-oracle-jdbc: 21
:version-lib-oracle-ucp: {version-lib-oracle-jdbc}
:version-plugin-jib: 0.10.1
Expand Down Expand Up @@ -141,7 +141,7 @@ endif::[]
:microprofile-graphql-base-url: {microprofile-base-url}/microprofile-graphql-{version-lib-microprofile-graphql}
:microprofile-graphql-spec-url: {microprofile-graphql-base-url}/microprofile-graphql-spec-{version-lib-microprofile-graphql}.html
:microprofile-graphql-javadoc-url: {microprofile-rest-graphql-url}/apidocs
:microprofile-graphql-javadoc-url: {microprofile-graphql-base-url}/apidocs
// Jakarta versioned URLs
Expand All @@ -152,11 +152,11 @@ endif::[]
:jakarta-cdi-javadoc-url: {jakarta-cdi-base-url}/apidocs/
:jakarta-websocket-base-url: {jakarta-base-url}/websocket/{version-lib-jakarta-websockets-api}
:jakarta-websocket-spec-url: {jakarta-websocket-base-url}/websocket-spec-{version-lib-jakarta-websockets-api}.html
:jakarta-websocket-spec-url: {jakarta-websocket-base-url}/jakarta-websocket-spec-{version-lib-jakarta-websockets-api}.html
:jakarta-websocket-javadoc-url: {jakarta-websocket-base-url}/apidocs/
:jakarta-bean-validation-base-url: {jakarta-base-url}/bean-validation/{version-lib-jakarta-bean-validation}
:jakarta-bean-validation-spec-url: {jakarta-bean-validation-base-url}/bean-validation_{version-lib-jakarta-bean-validation}.html
:jakarta-bean-validation-spec-url: {jakarta-bean-validation-base-url}/jakarta-bean-validation-spec-{version-lib-jakarta-bean-validation}.html
:jakarta-bean-validation-javadoc-url: {jakarta-bean-validation-base-url}/apidocs
:jakarta-jsonp-base-url: {jakarta-base-url}/jsonp/{version-lib-jakarta-jsonp-api}
Expand Down Expand Up @@ -267,7 +267,7 @@ endif::[]
:oracle-ucp-javadoc-base-url: https://docs.oracle.com/en/database/oracle/oracle-database/{version-lib-oracle-ucp}/jjuar
:micrometer-url: https://micrometer.io
:micrometer-api-url: https://micrometer.io/docs/concepts
:micrometer-api-url: https://docs.micrometer.io/micrometer/reference/concepts.html
:micrometer-javadoc-base-url: https://javadoc.io/doc/io.micrometer
:micrometer-javadoc-registry-prometheus-base-url: {micrometer-javadoc-base-url}/micrometer-registry-prometheus/{version-lib-micrometer}/io/micrometer/prometheus
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/includes/openapi/openapi.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 @@ -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 `<build><plugins>`
Add the link:https://github.com/smallrye/jandex/tree/main/maven-plugin[Jandex maven plug-in] to the `<build><plugins>`
section of your `pom.xml`:
[source,xml,subs="attributes+"]
Expand Down Expand Up @@ -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[]
// end::additional-building-jandex[]
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/mp/beanvalidation.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 @@ -396,12 +396,12 @@ public class GreetingProvider {
+
NOTE: `beans.xml` is required to identify beans and for bean validation to work properly.
Examples are available in link:{helidon-github-tree-url}}/examples/microprofile/bean-validation[our official GitHub repository].
Examples are available in link:{helidon-github-tree-url}/examples/microprofile/bean-validation[our official GitHub repository].
== Additional Information
Helidon uses link:https://hibernate.org/validator/[Hibernate Bean Validator] for general bean validation.
== Reference
* link:{jakarta-bean-validation-spec-url}}[Bean Validation Specification]
* link:{jakarta-bean-validation-spec-url}[Bean Validation Specification]
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/mp/config/introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

///////////////////////////////////////////////////////////////////////////////

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 @@ -243,5 +243,5 @@ Step-by-step guide about using {spec-name} in your Helidon MP application.
== Reference
* link:{microprofile-config-spec-url}}[{spec-name} Specifications]
* link:{microprofile-config-spec-url}[{spec-name} Specifications]
* link:{microprofile-fault-tolerance-javadoc-url}[{spec-name} Javadocs]
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/mp/fault-tolerance.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 @@ -227,4 +227,4 @@ link:{microprofile-fault-tolerance-javadoc-url}[MicroProfile Fault Tolerance Jav
== Reference
* link:{microprofile-fault-tolerance-spec-url}}[MicroProfile Fault Tolerance]
* link:{microprofile-fault-tolerance-spec-url}[MicroProfile Fault Tolerance]
7 changes: 3 additions & 4 deletions docs/src/main/asciidoc/mp/guides/mp-tutorial.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 Down Expand Up @@ -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
Expand Down Expand Up @@ -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]
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/mp/guides/upgrade_4x.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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}*:
+
Expand Down Expand Up @@ -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.
Please proceed to xref:../introduction.adoc[Helidon MP Introduction] to find more information and documentation about each module.
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/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 @@ -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]
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/mp/openapi/openapi.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 @@ -257,7 +257,7 @@ curl -X GET http://localhost:8080/openapi
The output describes not only then endpoints from `GreetResource` but
also one contributed by the `SimpleAPIModelReader`.
Full example is available link:{helidon-github-tree-url}}/examples/microprofile/openapi[in our official repository]
Full example is available link:{helidon-github-tree-url}/examples/microprofile/openapi[in our official repository]
== Additional Information
Expand Down
8 changes: 4 additions & 4 deletions docs/src/main/asciidoc/mp/persistence.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 @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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]
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/mp/testing-ng.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 @@ -193,4 +193,4 @@ public class TestReqScopeDisabledDiscovery {
== Reference
* https://testng.org/doc/documentation-main.html[TestNG User Guide]
* https://testng.org[TestNG Documentation]
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/se/guides/tracing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,8 @@ server:
host: 0.0.0.0
----
NOTE: The settings above are for development and experimental purposes only. For a production environment please see the xref:../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 `GreetService` class. Replace the `getDefaultMessageHandler` method:
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/se/security/providers.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 Down Expand Up @@ -104,12 +104,12 @@ include::{rootdir}/includes/security/providers/jwt.adoc[]
== Reference
* link:{https://github.com/oracle/helidon/tree/master/examples/security[Helidon Security Examples]
* link:{helidon-github-tree-url}examples/security[Helidon Security Examples]
* link:{security-provider-oidc-base-url}/module-summary.html[Helidon OIDC JavaDoc]
* link:{security-provider-httpauth-base-url}/module-summary.html[Helidon HTTP Authentication JavaDoc]
* link:{security-provider-header-base-url}/module-summary.html[Helidon Header Authentication JavaDoc]
* link:{security-provider-httpsign-base-url}/module-summary.html[Helidon HTTP Signature JavaDoc]
* link:{security-provider-idcs-mapper-base-url}/module-summary.html[Helidon IDCS Role Mapper JavaDoc]
* link:{security-provider-abac-base-url}/module-summary.html[Helidon ABAC JavaDoc]
* link:{security-provider-google-login-base-url}/module-summary.html[Helidon Google Login JavaDoc]
* link:{security-provider-jwt-base-url}/module-summary.html[Helidon JWT JavaDoc]
* link:{security-provider-jwt-base-url}/module-summary.html[Helidon JWT JavaDoc]

0 comments on commit c1a744f

Please sign in to comment.