diff --git a/authorization_services/document-attributes-product.adoc b/authorization_services/document-attributes-product.adoc deleted file mode 120000 index a2ea15b1e1..0000000000 --- a/authorization_services/document-attributes-product.adoc +++ /dev/null @@ -1 +0,0 @@ -../topics/document-attributes-product.adoc \ No newline at end of file diff --git a/authorization_services/master-docinfo.xml b/authorization_services/master-docinfo.xml index e51eb9ea4b..82845c7659 100644 --- a/authorization_services/master-docinfo.xml +++ b/authorization_services/master-docinfo.xml @@ -1,10 +1,10 @@ {project_name} -{project_doc_info_version_url} -For Use with {project_name} {project_doc_info_version_url} -{title} +{project_versionDoc} +For Use with {project_name} {project_versionDoc} +{authorizationguide_name} {doc_info_version_url} - This guide consists of information for authorization services for {project_name} {project_doc_info_version_url} + This guide consists of information for authorization services for {project_name} {project_versionDoc} Red Hat Customer Content Services diff --git a/authorization_services/master.adoc b/authorization_services/master.adoc index 23b53967de..1d80962dcf 100644 --- a/authorization_services/master.adoc +++ b/authorization_services/master.adoc @@ -2,5 +2,10 @@ :toclevels: 3 :numbered: -include::document-attributes-product.adoc[] +include::topics/templates/document-attributes-product.adoc[] + +:authorization_services_guide: + += {authorizationguide_name} + include::topics.adoc[] \ No newline at end of file diff --git a/authorization_services/metadata.ini b/authorization_services/metadata.ini deleted file mode 100644 index cb26fefb1f..0000000000 --- a/authorization_services/metadata.ini +++ /dev/null @@ -1,20 +0,0 @@ -[source] -language = en-US -type = book -markup = asciidoc - -[metadata] -title = Authorization Services Guide -product = Red Hat Single Sign-On -version = 7.0 -edition = -subtitle = -keywords = -abstract = - -[bugs] -reporting_url = -type = -product = -component = Documentation - diff --git a/authorization_services/topics/templates b/authorization_services/topics/templates new file mode 120000 index 0000000000..d191264115 --- /dev/null +++ b/authorization_services/topics/templates @@ -0,0 +1 @@ +../../topics/templates \ No newline at end of file diff --git a/getting_started/document-attributes-product.adoc b/getting_started/document-attributes-product.adoc deleted file mode 120000 index a2ea15b1e1..0000000000 --- a/getting_started/document-attributes-product.adoc +++ /dev/null @@ -1 +0,0 @@ -../topics/document-attributes-product.adoc \ No newline at end of file diff --git a/getting_started/master-docinfo.xml b/getting_started/master-docinfo.xml index 2154808846..76cc2e2c12 100644 --- a/getting_started/master-docinfo.xml +++ b/getting_started/master-docinfo.xml @@ -1,10 +1,10 @@ {project_name} -{project_doc_info_version_url} -For Use with {project_name} {project_doc_info_version_url} -{title} -{project_doc_info_version_url} +{project_versionDoc} +For Use with {project_name} {project_versionDoc} +{gettingstarted_name} +{project_versionDoc} - This guide consists of basic information and instructions to get started with {project_name} {project_doc_info_version_url} + This guide consists of basic information and instructions to get started with {project_name} {project_versionDoc} Red Hat Customer Content Services diff --git a/getting_started/master.adoc b/getting_started/master.adoc index 23b53967de..926d91a2b4 100644 --- a/getting_started/master.adoc +++ b/getting_started/master.adoc @@ -2,5 +2,10 @@ :toclevels: 3 :numbered: -include::document-attributes-product.adoc[] +include::topics/templates/document-attributes-product.adoc[] + +:getting_started_guide: + += {gettingstarted_name} + include::topics.adoc[] \ No newline at end of file diff --git a/getting_started/metadata.ini b/getting_started/metadata.ini deleted file mode 100644 index cebc6d848d..0000000000 --- a/getting_started/metadata.ini +++ /dev/null @@ -1,19 +0,0 @@ -[source] -language = en-US -type = book -markup = asciidoc - -[metadata] -title = Getting Started Guide -product = Red Hat Single Sign-On -version = 7.1.0 -edition = -subtitle = -keywords = -abstract = - -[bugs] -reporting_url = -type = -product = -component = Documentation diff --git a/getting_started/topics/templates b/getting_started/topics/templates new file mode 120000 index 0000000000..d191264115 --- /dev/null +++ b/getting_started/topics/templates @@ -0,0 +1 @@ +../../topics/templates \ No newline at end of file diff --git a/securing_apps/document-attributes-product.adoc b/securing_apps/document-attributes-product.adoc deleted file mode 120000 index a2ea15b1e1..0000000000 --- a/securing_apps/document-attributes-product.adoc +++ /dev/null @@ -1 +0,0 @@ -../topics/document-attributes-product.adoc \ No newline at end of file diff --git a/securing_apps/master-docinfo.xml b/securing_apps/master-docinfo.xml index bafad791be..62e682774a 100644 --- a/securing_apps/master-docinfo.xml +++ b/securing_apps/master-docinfo.xml @@ -1,10 +1,10 @@ {project_name} -{project_doc_info_version_url} -For Use with {project_name} {project_doc_info_version_url} -{title} +{project_versionDoc} +For Use with {project_name} {project_versionDoc} +{adapterguide_name} {doc_info_version_url} - This guide consists of information for securing applications and services using {project_name} {project_doc_info_version_url} + This guide consists of information for securing applications and services using {project_name} {project_versionDoc} Red Hat Customer Content Services diff --git a/securing_apps/master.adoc b/securing_apps/master.adoc index 23b53967de..3fda78cef5 100644 --- a/securing_apps/master.adoc +++ b/securing_apps/master.adoc @@ -2,5 +2,10 @@ :toclevels: 3 :numbered: -include::document-attributes-product.adoc[] +include::topics/templates/document-attributes-product.adoc[] + +:secure_applications_and_services_guide: + += {adapterguide_name} + include::topics.adoc[] \ No newline at end of file diff --git a/securing_apps/metadata.ini b/securing_apps/metadata.ini deleted file mode 100644 index 9200af5281..0000000000 --- a/securing_apps/metadata.ini +++ /dev/null @@ -1,20 +0,0 @@ -[source] -language = en-US -type = book -markup = asciidoc - -[metadata] -title = Securing Applications and Services Guide -product = Red Hat Single Sign-On -version = 7.0 -edition = -subtitle = -keywords = -abstract = - -[bugs] -reporting_url = -type = -product = -component = Documentation - diff --git a/securing_apps/topics/templates b/securing_apps/topics/templates new file mode 120000 index 0000000000..d191264115 --- /dev/null +++ b/securing_apps/topics/templates @@ -0,0 +1 @@ +../../topics/templates \ No newline at end of file diff --git a/server_admin/document-attributes-product.adoc b/server_admin/document-attributes-product.adoc deleted file mode 120000 index a2ea15b1e1..0000000000 --- a/server_admin/document-attributes-product.adoc +++ /dev/null @@ -1 +0,0 @@ -../topics/document-attributes-product.adoc \ No newline at end of file diff --git a/server_admin/master-docinfo.xml b/server_admin/master-docinfo.xml index 01c9b455fd..2846bd13bf 100644 --- a/server_admin/master-docinfo.xml +++ b/server_admin/master-docinfo.xml @@ -1,10 +1,10 @@ {project_name} -{project_doc_info_version_url} -For Use with {project_name} {project_doc_info_version_url} -{title} -{doc_info_version_url} +{project_versionDoc} +For Use with {project_name} {project_versionDoc} +{adminguide_name} +{project_versionDoc} - This guide consists of information for administrators to configure {project_name} {project_doc_info_version_url} + This guide consists of information for administrators to configure {project_name} {project_versionDoc} Red Hat Customer Content Services diff --git a/server_admin/master.adoc b/server_admin/master.adoc index 23b53967de..0e5a0783a0 100644 --- a/server_admin/master.adoc +++ b/server_admin/master.adoc @@ -2,5 +2,10 @@ :toclevels: 3 :numbered: -include::document-attributes-product.adoc[] -include::topics.adoc[] \ No newline at end of file +include::topics/templates/document-attributes-product.adoc[] + +:server_administration_guide: + += {adminguide_name} + +include::topics.adoc[] diff --git a/server_admin/metadata.ini b/server_admin/metadata.ini deleted file mode 100644 index 6cc67be75d..0000000000 --- a/server_admin/metadata.ini +++ /dev/null @@ -1,20 +0,0 @@ -[source] -language = en-US -type = book -markup = asciidoc - -[metadata] -title = Server Administration Guide -product = Red Hat Single Sign-On -version = 7.0 -edition = -subtitle = -keywords = -abstract = - -[bugs] -reporting_url = -type = -product = -component = Documentation - diff --git a/server_admin/topics/templates b/server_admin/topics/templates new file mode 120000 index 0000000000..d191264115 --- /dev/null +++ b/server_admin/topics/templates @@ -0,0 +1 @@ +../../topics/templates \ No newline at end of file diff --git a/server_development/document-attributes-product.adoc b/server_development/document-attributes-product.adoc deleted file mode 120000 index a2ea15b1e1..0000000000 --- a/server_development/document-attributes-product.adoc +++ /dev/null @@ -1 +0,0 @@ -../topics/document-attributes-product.adoc \ No newline at end of file diff --git a/server_development/master-docinfo.xml b/server_development/master-docinfo.xml index d97e3a207d..dd090918d0 100644 --- a/server_development/master-docinfo.xml +++ b/server_development/master-docinfo.xml @@ -1,10 +1,10 @@ {project_name} -{project_doc_info_version_url} -For Use with {project_name} {project_doc_info_version_url} -{title} -{project_doc_info_version_url} +{project_versionDoc} +For Use with {project_name} {project_versionDoc} +{developerguide_name} +{project_versionDoc} - This guides consist of information for developers to customize {project_name} {project_doc_info_version_url} + This guides consist of information for developers to customize {project_name} {project_versionDoc} Red Hat Customer Content Services diff --git a/server_development/master.adoc b/server_development/master.adoc index 23b53967de..d8cd4ad638 100644 --- a/server_development/master.adoc +++ b/server_development/master.adoc @@ -2,5 +2,10 @@ :toclevels: 3 :numbered: -include::document-attributes-product.adoc[] +include::topics/templates/document-attributes-product.adoc[] + +:server_developer_guide: + += {developerguide_name} + include::topics.adoc[] \ No newline at end of file diff --git a/server_development/metadata.ini b/server_development/metadata.ini deleted file mode 100644 index 2b2e5bac18..0000000000 --- a/server_development/metadata.ini +++ /dev/null @@ -1,20 +0,0 @@ -[source] -language = en-US -type = book -markup = asciidoc - -[metadata] -title = Server Developer Guide -product = Red Hat Single Sign-On -version = 7.0 -edition = -subtitle = -keywords = -abstract = - -[bugs] -reporting_url = -type = -product = -component = Documentation - diff --git a/server_development/topics/templates b/server_development/topics/templates new file mode 120000 index 0000000000..d191264115 --- /dev/null +++ b/server_development/topics/templates @@ -0,0 +1 @@ +../../topics/templates \ No newline at end of file diff --git a/server_installation/document-attributes-product.adoc b/server_installation/document-attributes-product.adoc deleted file mode 120000 index a2ea15b1e1..0000000000 --- a/server_installation/document-attributes-product.adoc +++ /dev/null @@ -1 +0,0 @@ -../topics/document-attributes-product.adoc \ No newline at end of file diff --git a/server_installation/master-docinfo.xml b/server_installation/master-docinfo.xml index f0228547d0..b012b36d1a 100644 --- a/server_installation/master-docinfo.xml +++ b/server_installation/master-docinfo.xml @@ -1,10 +1,10 @@ {project_name} -{project_doc_info_version_url} -For Use with {project_name} {project_doc_info_version_url} -{title} -{project_doc_info_version_url} +{project_versionDoc} +For Use with {project_name} {project_versionDoc} +{installguide_name} +{project_versionDoc} - This guide consists of information to install and configure {project_name} {project_doc_info_version_url} + This guide consists of information to install and configure {project_name} {project_versionDoc} Red Hat Customer Content Services diff --git a/server_installation/master.adoc b/server_installation/master.adoc index 23b53967de..8a75701028 100644 --- a/server_installation/master.adoc +++ b/server_installation/master.adoc @@ -2,5 +2,10 @@ :toclevels: 3 :numbered: -include::document-attributes-product.adoc[] +include::topics/templates/document-attributes-product.adoc[] + +:installguide_name: + += {server_installation_and_configuration_guide} + include::topics.adoc[] \ No newline at end of file diff --git a/server_installation/metadata.ini b/server_installation/metadata.ini deleted file mode 100644 index 14cac7aff1..0000000000 --- a/server_installation/metadata.ini +++ /dev/null @@ -1,20 +0,0 @@ -[source] -language = en-US -type = book -markup = asciidoc - -[metadata] -title = Server Installation and Configuration Guide -product = Red Hat Single Sign-On -version = 7.0 -edition = -subtitle = -keywords = -abstract = - -[bugs] -reporting_url = -type = -product = -component = Documentation - diff --git a/server_installation/topics/clustering/load-balancer.adoc b/server_installation/topics/clustering/load-balancer.adoc index 4cb5845530..7a3c2d781b 100644 --- a/server_installation/topics/clustering/load-balancer.adoc +++ b/server_installation/topics/clustering/load-balancer.adoc @@ -1,4 +1,4 @@ - +[[_setting-up-a-load-balancer-or-proxy]] === Setting Up a Load Balancer or Proxy This section discusses a number of things you need to configure before you can put a reverse proxy or load balancer diff --git a/server_installation/topics/database/checklist.adoc b/server_installation/topics/database/checklist.adoc index abc9e3b351..ed12a0de46 100644 --- a/server_installation/topics/database/checklist.adoc +++ b/server_installation/topics/database/checklist.adoc @@ -1,4 +1,4 @@ - +[[_rdbms-setup-checklist]] === RDBMS Setup Checklist These are the steps you will need to perform to get an RDBMS configured for {project_name}. diff --git a/server_installation/topics/templates b/server_installation/topics/templates new file mode 120000 index 0000000000..d191264115 --- /dev/null +++ b/server_installation/topics/templates @@ -0,0 +1 @@ +../../topics/templates \ No newline at end of file diff --git a/topics/document-attributes-community.adoc b/topics/templates/document-attributes-community.adoc similarity index 66% rename from topics/document-attributes-community.adoc rename to topics/templates/document-attributes-community.adoc index 3947994f28..503817cd6e 100644 --- a/topics/document-attributes-community.adoc +++ b/topics/templates/document-attributes-community.adoc @@ -4,28 +4,30 @@ :project_version: 3.3.0.CR1 :project_versionMvn: 3.3.0.CR1 :project_versionNpm: 3.3.0-cr.1 +:project_versionDoc: 3.3 :project_images: keycloak-images :project_doc_base_url: http://www.keycloak.org/documentation.html -:project_doc_info_version_url: 3.3 :quickstartRepo_link: https://github.com/keycloak/keycloak-quickstarts :quickstartRepo_name: Keycloak Quickstarts Repository :quickstartRepo_dir: keycloak-quickstarts -:adapterguide_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/securing-applications-and-services-guide/ +:authorizationguide_name: Authorization Services Guide +:authorizationguide_link: {project_doc_base_url}/{project_versionDoc}/html-single/authorization_services_guide/ :adapterguide_name: Securing Applications and Services Guide +:adapterguide_link: {project_doc_base_url}/{project_versionDoc}/html-single/securing-applications-and-services-guide/ +:adminguide_name: Server Administration Guide :adminguide_link: https://keycloak.gitbooks.io/documentation/content/server_admin/index.html -:adminguide_name: Server Administration -:apidocs_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/api-documentation/ :apidocs_name: API Documentation -:developerguide_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/server-developer-guide/ -:developerguide_name: Server Development -:gettingstarted_link: {project_doc_base_url}/{project_doc_info_version_url}/html/getting-started-guide/ -:gettingstarted_name: Getting Started Tutorial -:installguide_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/server-installation-and-configuration-guide/ -:installguide_name: Server Installation and Configuration -:installguide_profile_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/server-installation-and-configuration-guide/#profiles +:apidocs_link: {project_doc_base_url}/{project_versionDoc}/html-single/api-documentation/ +:developerguide_name: Server Development Guide +:developerguide_link: {project_doc_base_url}/{project_versionDoc}/html-single/server-developer-guide/ +:gettingstarted_name: Getting Started Guide +:gettingstarted_link: {project_doc_base_url}/{project_versionDoc}/html/getting-started-guide/ +:installguide_name: Server Installation and Configuration Guide +:installguide_link: {project_doc_base_url}/{project_versionDoc}/html-single/server-installation-and-configuration-guide/ :installguide_profile_name: Profiles +:installguide_profile_link: {project_doc_base_url}/{project_versionDoc}/html-single/server-installation-and-configuration-guide/#profiles :appserver_name: WildFly :appserver_doc_base_url: https://docs.jboss.org/author/display/WFLY10 diff --git a/topics/document-attributes-product.adoc b/topics/templates/document-attributes-product.adoc similarity index 63% rename from topics/document-attributes-product.adoc rename to topics/templates/document-attributes-product.adoc index 54831a8a30..fe4f20bd66 100644 --- a/topics/document-attributes-product.adoc +++ b/topics/templates/document-attributes-product.adoc @@ -4,48 +4,50 @@ :project_version: 7.2.0.DR4 :project_versionMvn: 3.3.0.Final-redhat1 :project_versionNpm: 3.3.0.Final-redhat1 +:project_versionDoc: 7.2 :project_images: rhsso-images :project_doc_base_url: https://access.redhat.com/documentation/en/red-hat-single-sign-on/ -:project_doc_info_version_url: 7.2 -:quickstartRepo_link: https://github.com/keycloak/keycloak-quickstarts -:quickstartRepo_name: Keycloak Quickstarts Repository -:quickstartRepo_dir: keycloak-quickstarts +:quickstartRepo_name: {project_name} Quickstarts Repository +:quickstartRepo_link: https://github.com/redhat-developer/redhat-sso-quickstarts +:quickstartRepo_dir: redhat-sso-quickstarts -:adapterguide_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/securing-applications-and-services-guide/ +:authorizationguide_name: Authorization Services Guide +:authorizationguide_link: {project_doc_base_url}/{project_versionDoc}/html-single/authorization_services_guide/ :adapterguide_name: Securing Applications and Services Guide +:adapterguide_link: {project_doc_base_url}/{project_versionDoc}/html-single/securing-applications-and-services-guide/ +:adminguide_name: Server Administration Guide :adminguide_link: https://keycloak.gitbooks.io/documentation/content/server_admin/index.html -:adminguide_name: Server Administration -:apidocs_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/api-documentation/ :apidocs_name: API Documentation -:developerguide_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/server-developer-guide/ -:developerguide_name: Server Development -:gettingstarted_link: {project_doc_base_url}/{project_doc_info_version_url}/html/getting-started-guide/ -:gettingstarted_name: Getting Started Tutorial -:installguide_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/server-installation-and-configuration-guide/ -:installguide_name: Server Installation and Configuration -:installguide_profile_link: {project_doc_base_url}/{project_doc_info_version_url}/html-single/server-installation-and-configuration-guide/#profiles +:apidocs_link: {project_doc_base_url}/{project_versionDoc}/html-single/api-documentation/ +:developerguide_name: Server Development Guide +:developerguide_link: {project_doc_base_url}/{project_versionDoc}/html-single/server-developer-guide/ +:gettingstarted_name: Getting Started Guide +:gettingstarted_link: {project_doc_base_url}/{project_versionDoc}/html/getting-started-guide/ +:installguide_name: Server Installation and Configuration Guide +:installguide_link: {project_doc_base_url}/{project_versionDoc}/html-single/server-installation-and-configuration-guide/ :installguide_profile_name: Profiles +:installguide_profile_link: {project_doc_base_url}/{project_versionDoc}/html-single/server-installation-and-configuration-guide/#profiles :appserver_name: JBoss EAP :appserver_version: 7.0 :appserver_doc_base_url: https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/{appserver_version} -:appserver_socket_link: {appserver_doc_base_url}/html-single/configuration-guide/#network_and_port_configuration :appserver_socket_name: JBoss EAP Configuration Guide -:appserver_jgroups_link: {appserver_doc_base_url}/html-single/configuration-guide/#cluster_communication_jgroups +:appserver_socket_link: {appserver_doc_base_url}/html-single/configuration-guide/#network_and_port_configuration :appserver_jgroups_name: JBoss EAP Configuration Guide -:appserver_jpa_link: {appserver_doc_base_url}/html-single/development-guide/#hibernate +:appserver_jgroups_link: {appserver_doc_base_url}/html-single/configuration-guide/#cluster_communication_jgroups :appserver_jpa_name: JBoss EAP Development Guide -:appserver_network_link: {appserver_doc_base_url}/html-single/configuration-guide/#network_and_port_configuration +:appserver_jpa_link: {appserver_doc_base_url}/html-single/development-guide/#hibernate :appserver_network_name: JBoss EAP Configuration Guide -:appserver_datasource_link: {appserver_doc_base_url}/html-single/configuration-guide/#datasource_management +:appserver_network_link: {appserver_doc_base_url}/html-single/configuration-guide/#network_and_port_configuration :appserver_datasource_name: JBoss EAP Configuration Guide -:appserver_caching_link: {appserver_doc_base_url}/html-single/configuration-guide/#infinispan +:appserver_datasource_link: {appserver_doc_base_url}/html-single/configuration-guide/#datasource_management :appserver_caching_name: JBoss EAP Configuration Guide -:appserver_admindoc_link: {appserver_doc_base_url}/html-single/configuration-guide/configuration-guide +:appserver_caching_link: {appserver_doc_base_url}/html-single/configuration-guide/#infinispan :appserver_admindoc_name: JBoss EAP Configuration Guide -:appserver_loadbalancer_link: {appserver_doc_base_url}/html-single/configuration-guide/#configuring_high_availability +:appserver_admindoc_link: {appserver_doc_base_url}/html-single/configuration-guide/configuration-guide :appserver_loadbalancer_name: JBoss EAP Configuration Guide +:appserver_loadbalancer_link: {appserver_doc_base_url}/html-single/configuration-guide/#configuring_high_availability :fuseVersion: JBoss Fuse 6.3.0 Rollup 1