Skip to content

Commit

Permalink
docs rebranding
Browse files Browse the repository at this point in the history
  • Loading branch information
maximthomas committed Jul 8, 2024
1 parent eb3f5e7 commit bce1307
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
! CCPL HEADER END
!
! Copyright 2011-2015 ForgeRock AS
! Portions Copyright 2024 3A Systems LLC
!
-->
<section xml:id="accessing-doc-online"
Expand Down Expand Up @@ -66,13 +67,13 @@

<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="https://www.openidentityplatform.org/" />.
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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
! CCPL HEADER END
!
! Copyright 2013-2015 ForgeRock AS
! Portions Copyright 2024 3A Systems LLC
!
-->
<section xml:id="interface-stability"
Expand All @@ -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, Open Identity Platform Community defines interface stability labels
and uses these definitions in ForgeRock products.
and uses these definitions in Open Identity Platform products.
</para>

<variablelist>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
! CCPL HEADER END
!
! Copyright 2015 ForgeRock AS.
! Portions Copyright 2024 3A Systems LLC.
!
-->
<section xml:id="sec-support-contact"
Expand All @@ -28,7 +29,7 @@
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>
Open Identity Platform
<link xlink:href="https://github.com/OpenIdentityPlatform/.github/wiki/Approved-Vendor-List">approved vendors</link>
Expand Down
9 changes: 5 additions & 4 deletions commons/doc-common-content/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"/>
Expand Down
9 changes: 5 additions & 4 deletions commons/doc-common-content/src/site/xdoc/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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="[email protected]">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>

Expand Down
2 changes: 1 addition & 1 deletion commons/doc-default-branding/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
7 changes: 4 additions & 3 deletions commons/doc-default-branding/src/site/xdoc/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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="[email protected]">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.
Expand Down

0 comments on commit bce1307

Please sign in to comment.