Skip to content

OLS-2240: run vale checks on install assembly #101211

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
Oct 29, 2025
Merged

OLS-2240: run vale checks on install assembly #101211

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
32 changes: 4 additions & 28 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,6 @@
StylesPath = .vale/styles
MinAlertLevel = warning
Packages = https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip

MinAlertLevel = suggestion

Packages = RedHat, AsciiDoc, OpenShiftAsciiDoc

# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
[[!.]*.adoc]
BasedOnStyles = RedHat, AsciiDoc, OpenShiftAsciiDoc

# Disabling rules (NO)
RedHat.ReleaseNotes = NO

# Use local OpenShiftDocs Vocab terms
Vale.Terms = YES
Vale.Avoid = YES

# Disable module specific rules
OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment = NO
OpenShiftAsciiDoc.NoNestingInModules = NO
OpenShiftAsciiDoc.NoXrefInModules = NO
OpenShiftAsciiDoc.IdHasContextVariable = NO
OpenShiftAsciiDoc.NoTocInModules = NO

# Optional: pass doc attributes to asciidoctor before linting
# Temp values are used for Prow CI comment linting only
[asciidoctor]
temp-ifdef = YES
temp-ifndef = NO
temp-ifeval = temp
[*.adoc]
BasedOnStyles = AsciiDocDITA
2 changes: 2 additions & 0 deletions install/ols-installing-openshift-lightspeed.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
:_content-type: ASSEMBLY
[id="ols-installing-lightspeed"]
= Installing OpenShift Lightspeed

include::_attributes/common-attributes.adoc[]
:context: ols-installing-openshift-lightspeed

toc::[]

[role="_abstract"]
The installation process for {ols-official} consists of two main tasks: installing the {ols-long} Operator and configuring the {ols-long} Service to interact with the large language model (LLM) provider.

include::modules/ols-large-language-model-overview.adoc[leveloffset=+1]
Expand Down
3 changes: 2 additions & 1 deletion modules/ols-about-subscription-requirements.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
[id="about-subscription-requirements_{context}"]
= About subscription requirements

{ols-official} requires an active and valid subscription to one of the following products:
[role="_abstract"]
{ols-official} requires a valid and active subscription to one of the listed OpenShift products.

* {oke-first}
* {ove-first}
Expand Down
6 changes: 6 additions & 0 deletions modules/ols-installing-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
// Module included in the following assemblies:
// * lightspeed-docs-main/install/ols-installing-openshift-lightspeed.adoc

:_mod-docs-content-type: PROCEDURE
[id="ols-installing-operator_{context}"]
= Installing the OpenShift Lightspeed Operator

[role="_abstract"]
Install the {ols-long} Operator so that you can configure the {ols-long} Service.

.Prerequisites

* You have deployed {ocp-product-title} 4.16 or later. The cluster must be connected to the Internet and have telemetry enabled.
Expand Down
1 change: 1 addition & 0 deletions modules/ols-large-language-model-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

= Large Language Model (LLM) overview

[role="_abstract"]
A large language model (LLM) is a type of artificial intelligence program trained on vast quantities of data. The {ols-long} Service interacts with the LLM to generate answers to questions.

You can configure {rhelai} or {rhoai} as the LLM provider for the {ols-long} Service. Either LLM provider can use a server or inference service that processes inference queries.
Expand Down