From ffa8a7f757fd3b79e5b2ef85cdd8decf5c718e75 Mon Sep 17 00:00:00 2001 From: Valera V Harseko Date: Wed, 30 Sep 2026 21:23:45 +0300 Subject: [PATCH 1/2] SEO: declare the sitemap in robots.txt, add description and OpenGraph tags - antora-playbook.yml: robots.txt declares Sitemap: https://doc.openidentityplatform.org/sitemap.xml - head-meta.hbs: generated for pages without :description:, OpenGraph (og:type, og:site_name, og:title, og:description, og:url, og:image) and twitter:card tags - meta-description.hbs: the generated description Fixes #24 --- antora-playbook.yml | 19 ++++++++++++++++- supplemental-ui/partials/head-meta.hbs | 17 +++++++++++++-- supplemental-ui/partials/meta-description.hbs | 21 +++++++++++++++++++ 3 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 supplemental-ui/partials/meta-description.hbs diff --git a/antora-playbook.yml b/antora-playbook.yml index 279a37c9f38..7d861ec4126 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,8 +1,25 @@ +# 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. + site: title: Open Identity Platform Documentation start_page: ROOT::index.adoc url: https://doc.openidentityplatform.org - robots: allow + robots: | + User-agent: * + Allow: / + Sitemap: https://doc.openidentityplatform.org/sitemap.xml keys: google_analytics: 'G-TFFQQ60TMD' google_site_verification: 'gB-OZuT18mmNEL-k5UNMHmNWQX5Wv46GnWWs1XZxZeE' diff --git a/supplemental-ui/partials/head-meta.hbs b/supplemental-ui/partials/head-meta.hbs index f836c48a123..cff623e272f 100644 --- a/supplemental-ui/partials/head-meta.hbs +++ b/supplemental-ui/partials/head-meta.hbs @@ -13,8 +13,21 @@ * information: "Portions copyright [year] [name of copyright owner]". * * Copyright 2017 ForgeRock AS. - * Portions copyright 2024 3A Systems LLC. + * Portions copyright 2024-2026 3A Systems LLC. --> {{#with site.keys.googleSiteVerification}} -{{/with}} \ No newline at end of file +{{/with}} +{{!-- The UI emits only for a page that sets :description:; fall back to a generated one --}} +{{#unless page.description}} + +{{/unless}} + + + + +{{#with page.canonicalUrl}} + +{{/with}} + + diff --git a/supplemental-ui/partials/meta-description.hbs b/supplemental-ui/partials/meta-description.hbs new file mode 100644 index 00000000000..f558695dae9 --- /dev/null +++ b/supplemental-ui/partials/meta-description.hbs @@ -0,0 +1,21 @@ +{{!-- + * 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]". + * + * Copyright 2026 3A Systems, LLC. +--}} +{{!-- Description of a page that sets no :description:, used by head-meta.hbs --}} +{{~#if (and page.component (ne page.component.name 'ROOT'))~}} +{{{detag page.title attribute=true}}} - {{page.component.title}} documentation, Open Identity Platform +{{~else~}} +Documentation of the Open Identity Platform: OpenAM access management, OpenDJ directory services, OpenIDM identity management and OpenIG identity gateway +{{~/if~}} From 872dec2d1556cb56dd3e1d060697d4f506a0cf9e Mon Sep 17 00:00:00 2001 From: Valera V Harseko Date: Thu, 1 Oct 2026 15:33:52 +0300 Subject: [PATCH 2/2] Address review: note on the robots Sitemap host, 3A copyright on the playbook --- antora-playbook.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/antora-playbook.yml b/antora-playbook.yml index 7d861ec4126..87141ef60b2 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -10,12 +10,13 @@ # 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. +# Copyright 2024-2026 3A Systems, LLC. site: title: Open Identity Platform Documentation start_page: ROOT::index.adoc url: https://doc.openidentityplatform.org + # Antora writes robots verbatim: keep the Sitemap host in sync with site.url above. robots: | User-agent: * Allow: /