Skip to content

OLS-2269: Update BYOK frontmatter #101727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2025
Merged

OLS-2269: Update BYOK frontmatter #101727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions configure/ols-configuring-openshift-lightspeed.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
23 changes: 23 additions & 0 deletions modules/ols-about-document-title-and-url.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Copy link
Contributor

@shreyasiddhartha shreyasiddhartha Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[role="_abstract"]

Suggestion to add "[role="_abstract"]" at the beginning of your module. Feel free to skip this if you're planning to cover this separately for your docs set. :)

Copy link
Contributor Author

@rh-tokeefe rh-tokeefe Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shreyasiddhartha I was planning to address this using the tool, but this is a new file so I might as well start building the practice of making sure it's in the files. Thanks for the suggestion!

Pushed the change.

[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.