From dd311b9000659d1547955f40f4f17e5a1e4fa047 Mon Sep 17 00:00:00 2001 From: Valera V Harseko Date: Wed, 30 Sep 2026 21:30:43 +0300 Subject: [PATCH 1/2] Link API docs (Javadoc) from the start page and the Projects menu - index.adoc: an "API Reference (Javadoc)" link in each product section, and an "API Reference (Javadoc)" section listing the four products and the OpenICF and Commons libraries, whose Javadoc was reachable only by URL - header-content.hbs: an "API Reference (Javadoc)" entry in the Projects menu, pointing to that section Fixes #22 --- ROOT/modules/ROOT/pages/index.adoc | 35 +++++++++++++++++++++ supplemental-ui/partials/header-content.hbs | 2 ++ 2 files changed, 37 insertions(+) diff --git a/ROOT/modules/ROOT/pages/index.adoc b/ROOT/modules/ROOT/pages/index.adoc index 0492496d0ae..29bb0d60f6b 100644 --- a/ROOT/modules/ROOT/pages/index.adoc +++ b/ROOT/modules/ROOT/pages/index.adoc @@ -1,3 +1,18 @@ +//// +The contents of this file are subject to the terms of the Common Development and +Distribution License (the License). You may not use this file except in compliance with the +License. + +You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the +specific language governing permission and limitations under the License. + +When distributing Covered Software, include this CDDL Header Notice in each file and include +the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL +Header, with the fields enclosed by brackets [] replaced by your own identifying +information: "Portions copyright [year] [name of copyright owner]". + +Portions Copyright 2026 3A Systems, LLC. +//// = Open Identity Platform Documentation == xref:opendj:ROOT:index.adoc[OpenDJ: Directory Services] @@ -10,6 +25,7 @@ the power of the Java platform makes OpenDJ the simplest, fastest directory to d * xref:opendj:admin-guide:index.adoc[] * xref:opendj:server-dev-guide:index.adoc[] * xref:opendj:reference:index.adoc[] +* link:/opendj/apidocs/index.html[API Reference (Javadoc)] == xref:openam:ROOT:index.adoc[OpenAM: Access Management] @@ -25,6 +41,7 @@ Open Access Management (OpenAM) is an access management solution that includes A * xref:openam:reference:index.adoc[] * xref:openam:web-users-guide:index.adoc[] * xref:openam:jee-users-guide:index.adoc[] +* link:/openam/apidocs/index.html[API Reference (Javadoc)] == xref:openig:ROOT:index.adoc[OpenIG: Identity Gateway] @@ -34,6 +51,7 @@ and credential replay functionality. * xref:openig:gateway-guide:index.adoc[] * xref:openig:reference:index.adoc[] +* link:/openig/apidocs/index.html[API Reference (Javadoc)] == xref:openidm:ROOT:index.adoc[OpenIDM: Identity Management] @@ -46,3 +64,20 @@ and things is a repetitive and potentially time-consuming task that has a signif * xref:openidm:samples-guide:index.adoc[] * xref:openidm:integrators-guide:index.adoc[] * xref:openidm:connectors-guide:index.adoc[] +* link:/openidm/apidocs/index.html[API Reference (Javadoc)] + + +[#api-reference] +== API Reference (Javadoc) + +=== Products + +* link:/opendj/apidocs/index.html[OpenDJ: Directory Services] +* link:/openam/apidocs/index.html[OpenAM: Access Management] +* link:/openig/apidocs/index.html[OpenIG: Identity Gateway] +* link:/openidm/apidocs/index.html[OpenIDM: Identity Management] + +=== Libraries + +* link:/openicf/apidocs/index.html[OpenICF] - the Open Identity Connectors Framework, which OpenIDM uses to connect to external resources +* link:/commons/apidocs/index.html[Commons] - libraries shared by the Open Identity Platform products diff --git a/supplemental-ui/partials/header-content.hbs b/supplemental-ui/partials/header-content.hbs index 64e98c2020e..3b0d90186e4 100644 --- a/supplemental-ui/partials/header-content.hbs +++ b/supplemental-ui/partials/header-content.hbs @@ -45,6 +45,8 @@ OpenAM: Access Management OpenIG: Identity Gateway OpenIDM: Identity Management +
+ API Reference (Javadoc) From 6b2c6200a779d0553b426c4078a1fd5df862a632 Mon Sep 17 00:00:00 2001 From: Valera V Harseko Date: Thu, 1 Oct 2026 15:16:46 +0300 Subject: [PATCH 2/2] Drop the CDDL header from the start page The page had no header, and no other ROOT page has one; the header also pointed to legal/CDDLv1.0.txt, which this repository does not have. --- ROOT/modules/ROOT/pages/index.adoc | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/ROOT/modules/ROOT/pages/index.adoc b/ROOT/modules/ROOT/pages/index.adoc index 29bb0d60f6b..8f964288c2b 100644 --- a/ROOT/modules/ROOT/pages/index.adoc +++ b/ROOT/modules/ROOT/pages/index.adoc @@ -1,18 +1,3 @@ -//// -The contents of this file are subject to the terms of the Common Development and -Distribution License (the License). You may not use this file except in compliance with the -License. - -You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the -specific language governing permission and limitations under the License. - -When distributing Covered Software, include this CDDL Header Notice in each file and include -the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL -Header, with the fields enclosed by brackets [] replaced by your own identifying -information: "Portions copyright [year] [name of copyright owner]". - -Portions Copyright 2026 3A Systems, LLC. -//// = Open Identity Platform Documentation == xref:opendj:ROOT:index.adoc[OpenDJ: Directory Services]