From 56708d1e921a61657cd6ec6dbb500170a3afde7d Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Tue, 4 Nov 2025 12:36:16 -0500 Subject: [PATCH] OLS-2269: Update BYOK frontmatter --- .../ols-configuring-openshift-lightspeed.adoc | 1 + modules/ols-about-document-title-and-url.adoc | 23 +++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 modules/ols-about-document-title-and-url.adoc diff --git a/configure/ols-configuring-openshift-lightspeed.adoc b/configure/ols-configuring-openshift-lightspeed.adoc index 7b6f63eccc93..2d8807417de3 100644 --- a/configure/ols-configuring-openshift-lightspeed.adoc +++ b/configure/ols-configuring-openshift-lightspeed.adoc @@ -30,6 +30,7 @@ include::modules/ols-granting-access-to-individual-users.adoc[leveloffset=+2] include::modules/ols-granting-access-to-user-group.adoc[leveloffset=+2] include::modules/ols-filtering-and-redacting-information.adoc[leveloffset=+1] include::modules/ols-about-the-byo-knowledge-tool.adoc[leveloffset=+1] +include::modules/ols-about-document-title-and-url.adoc[leveloffset=+2] include::modules/ols-providing-custom-knowledge-to-the-llm.adoc[leveloffset=+2] include::modules/ols-disabling-ocp-documentation-rag-database.adoc[leveloffset=+2] diff --git a/modules/ols-about-document-title-and-url.adoc b/modules/ols-about-document-title-and-url.adoc new file mode 100644 index 000000000000..3d97843ddc7a --- /dev/null +++ b/modules/ols-about-document-title-and-url.adoc @@ -0,0 +1,23 @@ +// Module included in the following assemblies: +// * lightspeed-docs-main/configure/ols-configuring-openshift-lightspeed.adoc + +:_mod-docs-content-type: CONCEPT +[id="about-document-title-and-url_{context}"] += About document title and URL + +[role="_abstract"] + +{ols-long} can display the titles and URLs of the documents that the Service uses to generate answers. In the retrieval-augmented generation (RAG) database, titles and URLs accompany documents as metadata. The BYO Knowledge tool can obtain the title and url attributes from YAML frontmatter if they reside in the Markdown files that the tool processes. + +[source,markdown] +---- +--- +title: "Introduction to Layers {#gimp-concepts-layers}" +url: "https://docs.gimp.org/3.0/en/gimp-using-layers.html" +--- + +# Introduction to Layers +... +---- + +If a Markdown file does not have frontmatter with the `title` and `url` attributes, the first top-level Markdown heading, for example `# Introduction to Layers`, becomes the title and the file path becomes the URL. \ No newline at end of file