update docs branding (#115)

* update docs branding * add https to external resources * docs rebranding
OpenIdentityPlatform · Jul 12, 2024 · 132a195 · 132a195
1 parent 4626409
commit 132a195
Show file tree

Hide file tree

Showing 14 changed files with 63 additions and 60 deletions.
diff --git a/commons/doc-common-content/src/main/resources/shared/sec-about-crest.xml b/commons/doc-common-content/src/main/resources/shared/sec-about-crest.xml
@@ -19,18 +19,19 @@
   ! CCPL HEADER END
   !
   !      Copyright 2015 ForgeRock AS.
+  !      Portions Copyright 2024 3A Systems LLC
   !
 -->
  <section xml:id="sec-about-crest"
           xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://docbook.org/ns/docbook
                               http://docbook.org/xml/5.0/xsd/docbook.xsd">
- <title>About ForgeRock Common REST</title>
+ <title>About Open Identity Platform Common REST</title>
 
  <para>
   For many REST APIs that are not defined by external standards,
-  ForgeRock products provide common ways
+  Open Identity Platform products provide common ways
   to access web resources and collections of resources.
   This section covers what is common across products.
   Adapt the examples to your types of resources and to your deployment.

diff --git a/commons/doc-common-content/src/main/resources/shared/sec-accessing-doc-online.xml b/commons/doc-common-content/src/main/resources/shared/sec-accessing-doc-online.xml
@@ -19,6 +19,7 @@
   ! CCPL HEADER END
   !
   !      Copyright 2011-2015 ForgeRock AS
+  !      Portions Copyright 2024 3A Systems LLC
   !
 -->
  <section xml:id="accessing-doc-online"
@@ -30,7 +31,7 @@
  <title>Accessing Documentation Online</title>
 
  <para>
-  ForgeRock core documentation, such as this document, aims to be
+  Open Identity Platform core documentation, such as this document, aims to be
   technically accurate and complete with respect to the software documented.
  </para>
 
@@ -66,20 +67,20 @@
 
  <para>
   The review process helps to ensure that documentation published for
-  a ForgeRock release is technically accurate and complete.
+  a Open Identity Platform release is technically accurate and complete.
  </para>
 
  <para>
   Fully reviewed, published core documentation is available at
-  <link xlink:show="new" xlink:href="http://backstage.forgerock.com/" />.
-  Use this documentation when working with a ForgeRock Enterprise release.
+  <link xlink:show="new" xlink:href="https://doc.openidentityplatform.org/" />.
+  Use this documentation when working with a Open Identity Platform release.
  </para>
 
  <para>
   You can find pre-release draft documentation at the online
   <link
    xlink:show="new"
-   xlink:href="http://forgerock.org"
+   xlink:href="https://github.com/OpenIdentityPlatform"
   >community resource center</link>.
   Use this documentation when trying a nightly build.
  </para>

diff --git a/commons/doc-common-content/src/main/resources/shared/sec-interface-stability.xml b/commons/doc-common-content/src/main/resources/shared/sec-interface-stability.xml
@@ -19,6 +19,7 @@
   ! CCPL HEADER END
   !
   !      Copyright 2013-2015 ForgeRock AS
+  !      Portions Copyright 2024 3A Systems LLC
   !
 -->
  <section xml:id="interface-stability"
@@ -27,10 +28,10 @@
           xsi:schemaLocation='http://docbook.org/ns/docbook
                               http://docbook.org/xml/5.0/xsd/docbook.xsd'
           xmlns:xlink='http://www.w3.org/1999/xlink'>
- <title>ForgeRock Product Interface Stability</title>
+ <title>Open Identity Platform Product Interface Stability</title>
 
  <para>
-  ForgeRock products support many protocols, APIs, GUIs,
+  Open Identity Platform products support many protocols, APIs, GUIs,
   and command-line interfaces.
 
   Some of these interfaces are standard and very stable.
@@ -40,10 +41,10 @@
 
  <para>
   We realize that you invest in these interfaces,
-  and therefore must know when and how ForgeRock expects them to change.
+  and therefore must know when and how Open Identity Platform Community expects them to change.
 
-  For that reason, ForgeRock defines interface stability labels
-  and uses these definitions in ForgeRock products.
+  For that reason, Open Identity Platform Community defines interface stability labels
+  and uses these definitions in Open Identity Platform products.
  </para>
 
  <variablelist>
@@ -90,7 +91,7 @@
      For previously stable interfaces,
      the change was likely announced in a previous release.
 
-     Deprecated interfaces will be removed from ForgeRock products.
+     Deprecated interfaces will be removed from Open Identity Platform products.
     </para>
    </listitem>
   </varlistentry>
@@ -112,8 +113,7 @@
      Internal and undocumented interfaces can change without notice.
 
      If you depend on one of these interfaces,
-     contact ForgeRock support
-     or email <link xlink:href="mailto:info@forgerock.com">info@forgerock.com</link>
+     contact Open Identity Platform <link xlink:href="https://github.com/OpenIdentityPlatform">support</link>
      to discuss your needs.
     </para>
    </listitem>

diff --git a/commons/doc-common-content/src/main/resources/shared/sec-joining-the-community.xml b/commons/doc-common-content/src/main/resources/shared/sec-joining-the-community.xml
@@ -27,13 +27,13 @@
           xsi:schemaLocation='http://docbook.org/ns/docbook
                               http://docbook.org/xml/5.0/xsd/docbook.xsd'
           xmlns:xlink='http://www.w3.org/1999/xlink'>
- <title>Joining the ForgeRock Community</title>
+ <title>Joining the Open Identity Platform Community</title>
 
  <para>
   Visit the
   <link
    xlink:show="new"
-   xlink:href="http://forgerock.org"
+   xlink:href="https://github.com/OpenIdentityPlatform"
   >community resource center</link>
   where you can find information about each project,
   download nightly builds, browse the resource catalog,

diff --git a/commons/doc-common-content/src/main/resources/shared/sec-release-levels.xml b/commons/doc-common-content/src/main/resources/shared/sec-release-levels.xml
@@ -19,17 +19,18 @@
   ! CCPL HEADER END
   !
   !      Copyright 2013-2015 ForgeRock AS.
+  !      Portions Copyright 2024 3A Systems LLC
   !
 -->
  <section xml:id="release-levels"
           xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
           xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
           xsi:schemaLocation='http://docbook.org/ns/docbook
                               http://docbook.org/xml/5.0/xsd/docbook.xsd'>
- <title>ForgeRock Product Release Levels</title>
+ <title>Open Identity Platform Product Release Levels</title>
 
  <para>
-  ForgeRock defines Major, Minor, and Maintenance product release levels.
+  Open Identity Platform defines Major, Minor, and Maintenance product release levels.
 
   The release level is reflected in the version number.
 

diff --git a/commons/doc-common-content/src/main/resources/shared/sec-support-contact.xml b/commons/doc-common-content/src/main/resources/shared/sec-support-contact.xml
@@ -19,6 +19,7 @@
   ! CCPL HEADER END
   !
   !      Copyright 2015 ForgeRock AS.
+  !      Portions Copyright 2024 3A Systems LLC.
   !
 -->
 <section xml:id="sec-support-contact"
@@ -28,25 +29,16 @@
                               http://docbook.org/xml/5.0/xsd/docbook.xsd'
          xmlns:xlink='http://www.w3.org/1999/xlink'>
 
- <title>Getting Support and Contacting ForgeRock</title>
+ <title>Getting Support and Contacting Open Identity Platform Community Members</title>
  <para>
-  ForgeRock provides support services, professional services, classes through
-  ForgeRock University, and partner services to assist you in setting up and
+  Open Identity Platform
+  <link xlink:href="https://github.com/OpenIdentityPlatform/.github/wiki/Approved-Vendor-List">approved vendors</link>
+  provide support services, professional services, and partner services to assist you in setting up and
   maintaining your deployments.
-  For a general overview of these services, see
-  <link xlink:show="new"
-        xlink:href="https://www.forgerock.com/en-us/services">ForgeRock Services</link>.
  </para>
  <para>
-  ForgeRock has staff members around the globe who
+  Open Identity Platform Community approved vendors have staff members around the globe who
   support our international customers and partners.
-  If you have any questions, contact ForgeRock using the address or telephone number
-  nearest to you at
-  <link
-   xlink:show="new"
-   xlink:href="https://www.forgerock.com/en-us/contact/">https://www.forgerock.com/en-us/contact/</link>
-  or send an email to ForgeRock at
-  <link xlink:show="new" xlink:href="mailto:info@forgerock.com">info@forgerock.com</link>.
  </para>
 
 </section>
diff --git a/commons/doc-common-content/src/site/site.xml b/commons/doc-common-content/src/site/site.xml
@@ -13,6 +13,7 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2013-2014 ForgeRock AS
+ * Portions Copyright 2024 3A Systems LLC.
 -->
 <project name="${project.name}"
          xmlns="http://maven.apache.org/DECORATION/1.0.1"
@@ -29,15 +30,15 @@
   <body>
 
     <breadcrumbs>
-      <item name="Developer Community" href="http://www.forgerock.org"/>
-      <item name="Commons" href="http://commons.forgerock.org"/>
+      <item name="Developer Community" href="https://github.com/OpenIdentityPlatform"/>
+      <item name="Commons" href="https://github.com/OpenIdentityPlatform/commons"/>
       <item name="Doc Common Content"
-            href="http://commons.forgerock.org/forgerock-doc-common-content"/>
+            href="https://github.com/OpenIdentityPlatform/commons/tree/master/commons/doc-common-content"/>
     </breadcrumbs>
 
     <menu name="Development">
       <item name="Join"
-            href="https://sso.forgerock.com/openam/UI/Login"/>
+            href="https://github.com/OpenIdentityPlatform"/>
       <item name="Issue Tracking" href="issue-tracking.html"/>
       <item name="License" href="license.html"/>
       <item name="Source Repository" href="source-repository.html"/>

diff --git a/commons/doc-common-content/src/site/xdoc/index.xml b/commons/doc-common-content/src/site/xdoc/index.xml
@@ -13,28 +13,29 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2013-2014 ForgeRock AS
+ * Portions Copyright 2024 3A Systems LLC
 -->
 <document xmlns="http://maven.apache.org/XDOC/2.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
                               http://maven.apache.org/xsd/xdoc-2.0.xsd">
 
  <properties>
-  <title>ForgeRock Doc Common Content</title>
-  <author email="docs@forgerock.org">ForgeRock AS</author>
+  <title>Open Identity Platform Doc Common Content</title>
+  <author>Open Identity Platform Community</author>
  </properties>
 
  <body>
 
   <section name="About Common Content">
 
    <p>
-    Some of the content in ForgeRock core documentation is common to all books.
+    Some of the content in Open Identity Platform core documentation is common to all books.
 
     This common content is provided as a separate Maven project
     that is maintained independently of any particular documentation set.
 
-    The common ForgeRock content includes text and images
+    The common Open Identity Platform content includes text and images
     in formats suitable for inclusion in DocBook 5 XML based core documentation.
    </p>
 

diff --git a/commons/doc-default-branding/README.md b/commons/doc-default-branding/README.md
@@ -4,7 +4,7 @@ This branding module acts as a customization layer on top of the default
 Docbook XSL stylesheets, and can be used to modify the look and feel
 of the output documentation.
 
-ForgeRock-customized stylesheets are provided in
+Open Identity Platform-customized stylesheets are provided in
 `main/resources/docbkx-stylesheets` for the following output
 targets:
 

diff --git a/commons/doc-default-branding/src/main/resources/docbkx-stylesheets/bootstrap/coredoc.xsl b/commons/doc-default-branding/src/main/resources/docbkx-stylesheets/bootstrap/coredoc.xsl
@@ -122,9 +122,9 @@
  <xsl:param name="toc.list.type">ul</xsl:param>
 
  <xsl:param name="html.script">
-  http://code.jquery.com/jquery-1.11.2.min.js
-  http://code.jquery.com/ui/1.11.4/jquery-ui.min.js
-  http://maxcdn.bootstrapcdn.com/bootstrap/3.3.0/js/bootstrap.min.js
+  https://code.jquery.com/jquery-1.11.2.min.js
+  https://code.jquery.com/ui/1.11.4/jquery-ui.min.js
+  https://maxcdn.bootstrapcdn.com/bootstrap/3.3.0/js/bootstrap.min.js
  </xsl:param>
 
  <xsl:param name="make.clean.html" select="1" />

diff --git a/commons/doc-default-branding/src/main/resources/docbkx-stylesheets/bootstrap/docbook.xsl b/commons/doc-default-branding/src/main/resources/docbkx-stylesheets/bootstrap/docbook.xsl
@@ -46,7 +46,7 @@
       <div class="navbar navbar-inverse navbar-fixed-top">
        <nav class="container-fluid">
         <div class="navbar-header">
-         <a href="index.html" class="navbar-brand">
+         <a href="/" class="navbar-brand">
              <span>Open Identity Platform</span>
          </a>
         </div>
@@ -132,8 +132,11 @@
         <div class="footer">
          <div class="container-fluid">
           <div class="footer-left"><span class="footer-item">Copyright ©
-           <xsl:value-of select="db:info/db:copyright/db:year"/>&#160;
-           <xsl:value-of select="db:info/db:copyright/db:holder"/></span></div>
+              <xsl:value-of select="db:info/db:copyright/db:year"/>&#160;
+              <xsl:value-of select="db:info/db:copyright/db:holder"/>;&#160;
+              <xsl:value-of select="db:info/db:copyrightoip/db:year"/>&#160;
+              <xsl:value-of select="db:info/db:copyrightoip/db:holder"/>&#160;
+          </span></div>
           <div class="footer-right">
               <a target="_blank" class="footer-item snap-left" href="legalnotice.html">
                   <i class="glyphicon glyphicon-briefcase"></i> Legal Notice</a>

diff --git a/commons/doc-default-branding/src/main/resources/docbkx-stylesheets/bootstrap/styles.css b/commons/doc-default-branding/src/main/resources/docbkx-stylesheets/bootstrap/styles.css
@@ -19,11 +19,11 @@
 /* Imported Styles
 /***********************************/
 
-@import url(http://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,300,400,700);
-@import url(http://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css);
-@import url(http://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css);
-/* @import url(http://cdnjs.cloudflare.com/ajax/libs/fancybox/2.1.5/jquery.fancybox.min.css); */
-@import url(http://cdnjs.cloudflare.com/ajax/libs/jquery.colorbox/1.4.33/example1/colorbox.css);
+@import url(https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,300,400,700);
+@import url(https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css);
+@import url(https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css);
+/* @import url(https://cdnjs.cloudflare.com/ajax/libs/fancybox/2.1.5/jquery.fancybox.min.css); */
+@import url(https://cdnjs.cloudflare.com/ajax/libs/jquery.colorbox/1.4.33/example1/colorbox.css);
 
 /***********************************/
 /* General Styles

diff --git a/commons/doc-default-branding/src/site/xdoc/index.xml b/commons/doc-default-branding/src/site/xdoc/index.xml
@@ -13,23 +13,24 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2013-2014 ForgeRock AS
+ * Portions Copyright 2024 3A Systems LLC
 -->
 <document xmlns="http://maven.apache.org/XDOC/2.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
                               http://maven.apache.org/xsd/xdoc-2.0.xsd">
 
  <properties>
-  <title>ForgeRock Doc Default Branding</title>
-  <author email="docs@forgerock.org">ForgeRock AS</author>
+  <title>Open Identity Platform Doc Default Branding</title>
+  <author>Open Identity Platform Community</author>
  </properties>
 
  <body>
 
   <section name="About Default Branding">
 
    <p>
-    By default, ForgeRock core documentation uses the branding from this project.
+    By default, Open Identity Platform core documentation uses the branding from this project.
 
     The branding project contains CSS for in-progress and released docs,
     and custom docbkx stylesheets for supported output formats.

diff --git a/commons/doc-maven-plugin/src/main/java/org/forgerock/doc/maven/post/Bootstrap.java b/commons/doc-maven-plugin/src/main/java/org/forgerock/doc/maven/post/Bootstrap.java
@@ -112,10 +112,12 @@ final void editBuiltHtml(final String htmlDir) throws
         try {
             HashMap<String, String> replacements = new HashMap<String, String>();
 
-            String gascript = IOUtils.toString(
-                    getClass().getResourceAsStream("/endhead-ga.txt"), "UTF-8");
-            gascript = gascript.replace("ANALYTICS-ID", m.getGoogleAnalyticsId());
-            replacements.put("</head>", gascript);
+            if(m.getGoogleAnalyticsId() != null) {
+                String gascript = IOUtils.toString(
+                        getClass().getResourceAsStream("/endhead-ga.txt"), "UTF-8");
+                gascript = gascript.replace("ANALYTICS-ID", m.getGoogleAnalyticsId());
+                replacements.put("</head>", gascript);
+            }
 
             HtmlUtils.updateHtml(htmlDir, replacements);
         } catch (IOException e) {