From e18ea48b26e48596896c5cb6cf2dbe53fdac825e Mon Sep 17 00:00:00 2001 From: Andy Munro Date: Thu, 18 Feb 2021 12:14:44 -0500 Subject: [PATCH] KEYCLOAK-16929 Adding conscious language preface of the release notes --- api_documentation/topics/overview.adoc | 3 +++ authorization_services/topics.adoc | 2 ++ getting_started/topics.adoc | 1 + openshift/topics.adoc | 2 ++ release_notes/master.adoc | 2 ++ securing_apps/master.adoc | 2 ++ securing_apps/topics/oidc/javascript-adapter.adoc | 6 +++--- server_admin/master.adoc | 2 ++ server_development/master.adoc | 2 ++ server_installation/master.adoc | 1 + topics/templates/making-open-source-more-inclusive.adoc | 7 +++++++ upgrading/master.adoc | 1 + 12 files changed, 28 insertions(+), 3 deletions(-) create mode 100644 topics/templates/making-open-source-more-inclusive.adoc diff --git a/api_documentation/topics/overview.adoc b/api_documentation/topics/overview.adoc index 9b4ffa58f1..a06996fbf7 100644 --- a/api_documentation/topics/overview.adoc +++ b/api_documentation/topics/overview.adoc @@ -1,3 +1,6 @@ + +include::templates/making-open-source-more-inclusive.adoc[] + == {project_name} API Documentation === JavaDocs Documentation diff --git a/authorization_services/topics.adoc b/authorization_services/topics.adoc index 5883c60020..3206ab0671 100644 --- a/authorization_services/topics.adoc +++ b/authorization_services/topics.adoc @@ -1,3 +1,5 @@ +include::topics/templates/making-open-source-more-inclusive.adoc[] + include::topics/auth-services-overview.adoc[leveloffset=+1] include::topics/auth-services-architecture.adoc[leveloffset=+2] diff --git a/getting_started/topics.adoc b/getting_started/topics.adoc index 767bdb668f..db184ae2fe 100644 --- a/getting_started/topics.adoc +++ b/getting_started/topics.adoc @@ -1,6 +1,7 @@ ifeval::[{project_community}==true] include::topics/introduction-keycloak.adoc[] endif::[] +include::topics/templates/making-open-source-more-inclusive.adoc[] include::topics/assembly-installing-standalone.adoc[] include::topics/assembly-creating-first-realm.adoc[] include::topics/assembly-securing-sample-app.adoc[] diff --git a/openshift/topics.adoc b/openshift/topics.adoc index b09679def7..e5c6eb4e08 100644 --- a/openshift/topics.adoc +++ b/openshift/topics.adoc @@ -1,3 +1,5 @@ +include::topics/templates/making-open-source-more-inclusive.adoc[] + include::topics/introduction.adoc[leveloffset=+0] include::topics/before_you_begin.adoc[leveloffset=+0] diff --git a/release_notes/master.adoc b/release_notes/master.adoc index 7e69780f65..21ad0baf7d 100644 --- a/release_notes/master.adoc +++ b/release_notes/master.adoc @@ -10,6 +10,8 @@ include::runtimes-common/attributes/runtimes-attributes.adoc[] = {releasenotes_name} +include::topics/templates/making-open-source-more-inclusive.adoc[] + == {project_name_full} 7.4.0.GA include::topics/product/7_4_final.adoc[leveloffset=2] diff --git a/securing_apps/master.adoc b/securing_apps/master.adoc index fa52bc507d..7b726dc74c 100644 --- a/securing_apps/master.adoc +++ b/securing_apps/master.adoc @@ -9,4 +9,6 @@ include::topics/templates/document-attributes-product.adoc[] = {adapterguide_name} +include::topics/templates/making-open-source-more-inclusive.adoc[] + include::topics.adoc[] \ No newline at end of file diff --git a/securing_apps/topics/oidc/javascript-adapter.adoc b/securing_apps/topics/oidc/javascript-adapter.adoc index feac513f77..8b2519ce55 100644 --- a/securing_apps/topics/oidc/javascript-adapter.adoc +++ b/securing_apps/topics/oidc/javascript-adapter.adoc @@ -98,7 +98,7 @@ It has no other task than sending the received tokens to the main application an Please keep in mind that this page at the specified location must be provided by the application itself and is _not_ part of the JavaScript adapter! -WARNING: _Silent_ `check-sso` functionality is limited in some modern browsers. Please see link:#_modern_browsers[Modern Browsers with Tracking Protection Section]. +WARNING: _Silent_ `check-sso` functionality is limited in some modern browsers. Please see the <<_modern_browsers,Modern Browsers with Tracking Protection Section>>. To enable `login-required` set `onLoad` to `login-required` and pass to the init method: @@ -160,7 +160,7 @@ This feature can be disabled by setting `checkLoginIframe: false` in the options You should not rely on looking at this cookie directly. Its format can change and it's also associated with the URL of the {project_name} server, not your application. -WARNING: Session Status iframe functionality is limited in some modern browsers. Please see link:#_modern_browsers[Modern Browsers with Tracking Protection Section]. +WARNING: Session Status iframe functionality is limited in some modern browsers. Please see <<_modern_browsers,Modern Browsers with Tracking Protection Section>>. [[_javascript_implicit_flow]] ==== Implicit and Hybrid Flow @@ -450,7 +450,7 @@ Options is an Object, where: * redirectUri - Specifies the uri to redirect to after login. * prompt - This parameter allows to slightly customize the login flow on the {project_name} server side. -For example enforce displaying the login screen in case of value `login`. See link:#_params_forwarding[Parameters Forwarding Section] +For example enforce displaying the login screen in case of value `login`. See link:{adapterguide_link}#_params_forwarding[Parameters Forwarding Section] for the details and all the possible values of the `prompt` parameter. * maxAge - Used just if user is already authenticated. Specifies maximum time since the authentication of user happened. If user is already authenticated for longer time than `maxAge`, the SSO is ignored and he will need to re-authenticate again. * loginHint - Used to pre-fill the username/email field on the login form. diff --git a/server_admin/master.adoc b/server_admin/master.adoc index 302098de35..d5372963ec 100644 --- a/server_admin/master.adoc +++ b/server_admin/master.adoc @@ -9,4 +9,6 @@ include::topics/templates/document-attributes-product.adoc[] = {adminguide_name} +include::topics/templates/making-open-source-more-inclusive.adoc[] + include::topics.adoc[] diff --git a/server_development/master.adoc b/server_development/master.adoc index 4534669897..09dcd4b4ca 100644 --- a/server_development/master.adoc +++ b/server_development/master.adoc @@ -9,4 +9,6 @@ include::topics/templates/document-attributes-product.adoc[] = {developerguide_name} +include::topics/templates/making-open-source-more-inclusive.adoc[] + include::topics.adoc[] \ No newline at end of file diff --git a/server_installation/master.adoc b/server_installation/master.adoc index b7e0461a6a..77445d557b 100644 --- a/server_installation/master.adoc +++ b/server_installation/master.adoc @@ -10,6 +10,7 @@ include::topics/templates/document-attributes-product.adoc[] = {installguide_name} +include::topics/templates/making-open-source-more-inclusive.adoc[] include::topics.adoc[] :context: diff --git a/topics/templates/making-open-source-more-inclusive.adoc b/topics/templates/making-open-source-more-inclusive.adoc new file mode 100644 index 0000000000..2b88037619 --- /dev/null +++ b/topics/templates/making-open-source-more-inclusive.adoc @@ -0,0 +1,7 @@ +ifeval::[{project_product}==true] +[preface] +[id="making-open-source-more-inclusive"] +== Making open source more inclusive + +Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see link:https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[our CTO Chris Wright's message]. +endif::[] diff --git a/upgrading/master.adoc b/upgrading/master.adoc index 1c23d40c13..f4e3d5cc3c 100644 --- a/upgrading/master.adoc +++ b/upgrading/master.adoc @@ -9,4 +9,5 @@ include::topics/templates/document-attributes-product.adoc[] = {upgradingguide_name} +include::topics/templates/making-open-source-more-inclusive.adoc[] include::topics.adoc[]