From 234ca9412c14930f805f267397002f951371fa96 Mon Sep 17 00:00:00 2001 From: Alexa Bird Date: Wed, 7 Aug 2024 19:01:51 -0700 Subject: [PATCH] Revert "updated documentation template files title fields (#6622)" This reverts commit 0818e39cc9bef3331e56e7b318b679b80303de17. --- .../docs/src/main/resources/templates/architectures.ftl | 2 +- distribution/docs/src/main/resources/templates/developing.ftl | 2 +- .../docs/src/main/resources/templates/documentation.ftl | 2 -- .../docs/src/main/resources/templates/integrating.ftl | 4 ++-- distribution/docs/src/main/resources/templates/managing.ftl | 4 ++-- distribution/docs/src/main/resources/templates/metadata.ftl | 2 +- distribution/docs/src/main/resources/templates/overview.ftl | 4 ++-- distribution/docs/src/main/resources/templates/quickstart.ftl | 2 +- distribution/docs/src/main/resources/templates/reference.ftl | 2 +- distribution/docs/src/main/resources/templates/using.ftl | 2 +- 10 files changed, 12 insertions(+), 14 deletions(-) diff --git a/distribution/docs/src/main/resources/templates/architectures.ftl b/distribution/docs/src/main/resources/templates/architectures.ftl index 4d74899dbb9f..bc51951c27f8 100644 --- a/distribution/docs/src/main/resources/templates/architectures.ftl +++ b/distribution/docs/src/main/resources/templates/architectures.ftl @@ -1,6 +1,6 @@ = ${branding-expanded} Architecture -:title: ${branding-expanded} Architecture include::config.adoc[] +:title: ${branding-expanded} Architecture :architecture-prefix: _ :developing-prefix: developing.adoc#_ :integrating-prefix: documentation.adoc#_ diff --git a/distribution/docs/src/main/resources/templates/developing.ftl b/distribution/docs/src/main/resources/templates/developing.ftl index 83c8089ff794..17b34e1bbf46 100644 --- a/distribution/docs/src/main/resources/templates/developing.ftl +++ b/distribution/docs/src/main/resources/templates/developing.ftl @@ -1,6 +1,6 @@ = Developing ${branding} Components: Developer's Guide -:title: Developing ${branding} Components: Developer's Guide include::config.adoc[] +:title: Developing ${branding} Components :architecture-prefix: architecture.adoc#_ :developing-prefix: _ :integrating-prefix: documentation.adoc#_ diff --git a/distribution/docs/src/main/resources/templates/documentation.ftl b/distribution/docs/src/main/resources/templates/documentation.ftl index 7331a30f11ed..7c236b4f8401 100644 --- a/distribution/docs/src/main/resources/templates/documentation.ftl +++ b/distribution/docs/src/main/resources/templates/documentation.ftl @@ -1,5 +1,4 @@ = ${branding-expanded} Documentation: Complete Documentation -:title: ${branding-expanded} Documentation: Complete Documentation include::config.adoc[] :architecture-prefix: _ :developing-prefix: _ @@ -69,7 +68,6 @@ ifdef::backend-pdf[] == Index endif::backend-pdf[] - ifdef::backend-html5[] include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[] diff --git a/distribution/docs/src/main/resources/templates/integrating.ftl b/distribution/docs/src/main/resources/templates/integrating.ftl index 0ff422f5d649..91755882e522 100644 --- a/distribution/docs/src/main/resources/templates/integrating.ftl +++ b/distribution/docs/src/main/resources/templates/integrating.ftl @@ -1,6 +1,6 @@ -= Integrating with ${branding} -:title: Integrating with ${branding} += Integrating ${branding} include::config.adoc[] +:title: Integrating ${branding} :architecture-prefix: architecture.adoc#_ :developing-prefix: developing.adoc#_ :integrating-prefix: _ diff --git a/distribution/docs/src/main/resources/templates/managing.ftl b/distribution/docs/src/main/resources/templates/managing.ftl index 7935b85f9bad..db598a8f76f0 100644 --- a/distribution/docs/src/main/resources/templates/managing.ftl +++ b/distribution/docs/src/main/resources/templates/managing.ftl @@ -1,6 +1,6 @@ -= Managing ${branding-expanded} -:title: Managing ${branding-expanded} += Managing include::config.adoc[] +:title: Managing ${branding} :architecture-prefix: architecture.adoc#_ :developing-prefix: developing.adoc#_ :integrating-prefix: documentation.adoc#_ diff --git a/distribution/docs/src/main/resources/templates/metadata.ftl b/distribution/docs/src/main/resources/templates/metadata.ftl index f7003a0419f7..ee040721f6c5 100644 --- a/distribution/docs/src/main/resources/templates/metadata.ftl +++ b/distribution/docs/src/main/resources/templates/metadata.ftl @@ -1,6 +1,6 @@ = ${branding} Metadata Reference Guide -:title: ${branding} Metadata Reference Guide include::config.adoc[] +:title: Metadata Reference Guide :toc: left :architecture-prefix: architecture.adoc#_ :developing-prefix: developing.adoc#_ diff --git a/distribution/docs/src/main/resources/templates/overview.ftl b/distribution/docs/src/main/resources/templates/overview.ftl index 09498836bae4..8348562392f5 100644 --- a/distribution/docs/src/main/resources/templates/overview.ftl +++ b/distribution/docs/src/main/resources/templates/overview.ftl @@ -1,6 +1,6 @@ -= ${branding-expanded} Executive Summary: Core Concepts and Introduction -:title: ${branding-expanded} Introduction += ${branding-expanded} Overview include::config.adoc[] +:title: ${branding-expanded} Executive Summary: Core Concepts and Introduction :architecture-prefix: architecture.adoc#_ :developing-prefix: developing.adoc#_ :integrating-prefix: documentation.adoc#_ diff --git a/distribution/docs/src/main/resources/templates/quickstart.ftl b/distribution/docs/src/main/resources/templates/quickstart.ftl index 5ed0062c73b5..d947e3aeeed6 100644 --- a/distribution/docs/src/main/resources/templates/quickstart.ftl +++ b/distribution/docs/src/main/resources/templates/quickstart.ftl @@ -1,6 +1,6 @@ = ${branding-expanded}: Quick Start Guide -:title: ${branding-expanded}: Quick Start Guide include::config.adoc[] +:title: ${branding-expanded} Quick Start Guide :architecture-prefix: architecture.adoc#_ :developing-prefix: developing.adoc#_ :integrating-prefix: documentation.adoc#_ diff --git a/distribution/docs/src/main/resources/templates/reference.ftl b/distribution/docs/src/main/resources/templates/reference.ftl index 0b1607700144..63b7bf20e962 100644 --- a/distribution/docs/src/main/resources/templates/reference.ftl +++ b/distribution/docs/src/main/resources/templates/reference.ftl @@ -1,6 +1,6 @@ = ${branding} Reference Guide -:title: ${branding} Reference Guide include::config.adoc[] +:title: Reference :toc: left :architecture-prefix: architecture.adoc#_ :developing-prefix: developing.adoc#_ diff --git a/distribution/docs/src/main/resources/templates/using.ftl b/distribution/docs/src/main/resources/templates/using.ftl index 237cd517c6ff..facf1b8c531c 100644 --- a/distribution/docs/src/main/resources/templates/using.ftl +++ b/distribution/docs/src/main/resources/templates/using.ftl @@ -1,6 +1,6 @@ = ${branding} User's Guide -:title: ${branding} User's Guide include::config.adoc[] +:title: Using ${catalog-ui} :architecture-prefix: architecture.adoc#_ :developing-prefix: developing.adoc#_ :integrating-prefix: documentation.adoc#_