From 132a195024a31c2441c5cf06efd265422ba30c89 Mon Sep 17 00:00:00 2001 From: Maxim Thomas Date: Fri, 12 Jul 2024 08:16:39 +0300 Subject: [PATCH] update docs branding (#115) * update docs branding * add https to external resources * docs rebranding --- .../main/resources/shared/sec-about-crest.xml | 5 +++-- .../shared/sec-accessing-doc-online.xml | 11 +++++----- .../shared/sec-interface-stability.xml | 16 +++++++-------- .../shared/sec-joining-the-community.xml | 4 ++-- .../resources/shared/sec-release-levels.xml | 5 +++-- .../resources/shared/sec-support-contact.xml | 20 ++++++------------- commons/doc-common-content/src/site/site.xml | 9 +++++---- .../src/site/xdoc/index.xml | 9 +++++---- commons/doc-default-branding/README.md | 2 +- .../docbkx-stylesheets/bootstrap/coredoc.xsl | 6 +++--- .../docbkx-stylesheets/bootstrap/docbook.xsl | 9 ++++++--- .../docbkx-stylesheets/bootstrap/styles.css | 10 +++++----- .../src/site/xdoc/index.xml | 7 ++++--- .../forgerock/doc/maven/post/Bootstrap.java | 10 ++++++---- 14 files changed, 63 insertions(+), 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 index 3d465c6b3..8fbe0263d 100644 --- 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,6 +19,7 @@ ! CCPL HEADER END ! ! Copyright 2015 ForgeRock AS. + ! Portions Copyright 2024 3A Systems LLC ! -->
- About ForgeRock Common REST + About Open Identity Platform Common REST 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 index 2edcde020..84d0248aa 100644 --- 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 ! -->
Accessing Documentation Online - 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. @@ -66,20 +67,20 @@ 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. Fully reviewed, published core documentation is available at - . - Use this documentation when working with a ForgeRock Enterprise release. + . + Use this documentation when working with a Open Identity Platform release. You can find pre-release draft documentation at the online community resource center. Use this documentation when trying a nightly build. 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 index bdbd4fccb..53febbcdd 100644 --- 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 ! -->
- ForgeRock Product Interface Stability + Open Identity Platform Product Interface Stability - 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 @@ 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. @@ -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. @@ -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 info@forgerock.com + contact Open Identity Platform support to discuss your needs. 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 index 62ae4a69a..a1a0452bd 100644 --- 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'> - Joining the ForgeRock Community + Joining the Open Identity Platform Community Visit the community resource center 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 index 5897e1f28..dec40a29c 100644 --- 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,6 +19,7 @@ ! CCPL HEADER END ! ! Copyright 2013-2015 ForgeRock AS. + ! Portions Copyright 2024 3A Systems LLC ! -->
- ForgeRock Product Release Levels + Open Identity Platform Product Release Levels - 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 index f0fc21d08..1dd5d205c 100644 --- 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. ! -->
- Getting Support and Contacting ForgeRock + Getting Support and Contacting Open Identity Platform Community Members - ForgeRock provides support services, professional services, classes through - ForgeRock University, and partner services to assist you in setting up and + Open Identity Platform + approved vendors + 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 - ForgeRock Services. - 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 - https://www.forgerock.com/en-us/contact/ - or send an email to ForgeRock at - info@forgerock.com.
diff --git a/commons/doc-common-content/src/site/site.xml b/commons/doc-common-content/src/site/site.xml index d2731a482..ae9f0a6cc 100644 --- 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. --> - - + + + href="https://github.com/OpenIdentityPlatform/commons/tree/master/commons/doc-common-content"/> + href="https://github.com/OpenIdentityPlatform"/> diff --git a/commons/doc-common-content/src/site/xdoc/index.xml b/commons/doc-common-content/src/site/xdoc/index.xml index eca5200bb..7651ab55b 100644 --- a/commons/doc-common-content/src/site/xdoc/index.xml +++ b/commons/doc-common-content/src/site/xdoc/index.xml @@ -13,6 +13,7 @@ * information: "Portions copyright [year] [name of copyright owner]". * * Copyright 2013-2014 ForgeRock AS + * Portions Copyright 2024 3A Systems LLC --> - ForgeRock Doc Common Content - ForgeRock AS + Open Identity Platform Doc Common Content + Open Identity Platform Community @@ -29,12 +30,12 @@

- 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.

diff --git a/commons/doc-default-branding/README.md b/commons/doc-default-branding/README.md index 43b90fbe0..a48a6f97f 100644 --- 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 index 17ff8b9a1..8e506a592 100644 --- 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 @@ ul - 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 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 index ce752334b..94a001332 100644 --- 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 @@