diff --git a/.vale.ini b/.vale.ini index 4746c2d9f605..efc51a29cf62 100644 --- a/.vale.ini +++ b/.vale.ini @@ -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 \ No newline at end of file diff --git a/install/ols-installing-openshift-lightspeed.adoc b/install/ols-installing-openshift-lightspeed.adoc index 5d50cd10a67b..d7ef3c8c31d2 100644 --- a/install/ols-installing-openshift-lightspeed.adoc +++ b/install/ols-installing-openshift-lightspeed.adoc @@ -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] diff --git a/modules/ols-about-subscription-requirements.adoc b/modules/ols-about-subscription-requirements.adoc index ee51d440e3a4..30939aaa4fc9 100644 --- a/modules/ols-about-subscription-requirements.adoc +++ b/modules/ols-about-subscription-requirements.adoc @@ -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} diff --git a/modules/ols-installing-operator.adoc b/modules/ols-installing-operator.adoc index 86fa3819c868..5ae6b28ec5bd 100644 --- a/modules/ols-installing-operator.adoc +++ b/modules/ols-installing-operator.adoc @@ -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. diff --git a/modules/ols-large-language-model-overview.adoc b/modules/ols-large-language-model-overview.adoc index 041065bb6fb8..be586bc4a2d5 100644 --- a/modules/ols-large-language-model-overview.adoc +++ b/modules/ols-large-language-model-overview.adoc @@ -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.