Skip to content

Commit 6da66cf

Browse files
authored
Merge pull request #101211 from rh-tokeefe/OLS-2240
OLS-2240: run vale checks on install assembly
2 parents 1e5cc5f + bafa684 commit 6da66cf

File tree

5 files changed

+15
-29
lines changed

5 files changed

+15
-29
lines changed

.vale.ini

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,6 @@
11
StylesPath = .vale/styles
2+
MinAlertLevel = warning
3+
Packages = https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip
24

3-
MinAlertLevel = suggestion
4-
5-
Packages = RedHat, AsciiDoc, OpenShiftAsciiDoc
6-
7-
# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
8-
[[!.]*.adoc]
9-
BasedOnStyles = RedHat, AsciiDoc, OpenShiftAsciiDoc
10-
11-
# Disabling rules (NO)
12-
RedHat.ReleaseNotes = NO
13-
14-
# Use local OpenShiftDocs Vocab terms
15-
Vale.Terms = YES
16-
Vale.Avoid = YES
17-
18-
# Disable module specific rules
19-
OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment = NO
20-
OpenShiftAsciiDoc.NoNestingInModules = NO
21-
OpenShiftAsciiDoc.NoXrefInModules = NO
22-
OpenShiftAsciiDoc.IdHasContextVariable = NO
23-
OpenShiftAsciiDoc.NoTocInModules = NO
24-
25-
# Optional: pass doc attributes to asciidoctor before linting
26-
# Temp values are used for Prow CI comment linting only
27-
[asciidoctor]
28-
temp-ifdef = YES
29-
temp-ifndef = NO
30-
temp-ifeval = temp
5+
[*.adoc]
6+
BasedOnStyles = AsciiDocDITA

install/ols-installing-openshift-lightspeed.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
:_content-type: ASSEMBLY
22
[id="ols-installing-lightspeed"]
33
= Installing OpenShift Lightspeed
4+
45
include::_attributes/common-attributes.adoc[]
56
:context: ols-installing-openshift-lightspeed
67

78
toc::[]
89

10+
[role="_abstract"]
911
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.
1012

1113
include::modules/ols-large-language-model-overview.adoc[leveloffset=+1]

modules/ols-about-subscription-requirements.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
[id="about-subscription-requirements_{context}"]
66
= About subscription requirements
77

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

1011
* {oke-first}
1112
* {ove-first}

modules/ols-installing-operator.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1+
// Module included in the following assemblies:
2+
// * lightspeed-docs-main/install/ols-installing-openshift-lightspeed.adoc
3+
14
:_mod-docs-content-type: PROCEDURE
25
[id="ols-installing-operator_{context}"]
36
= Installing the OpenShift Lightspeed Operator
47

8+
[role="_abstract"]
9+
Install the {ols-long} Operator so that you can configure the {ols-long} Service.
10+
511
.Prerequisites
612

713
* You have deployed {ocp-product-title} 4.16 or later. The cluster must be connected to the Internet and have telemetry enabled.

modules/ols-large-language-model-overview.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
= Large Language Model (LLM) overview
88

9+
[role="_abstract"]
910
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.
1011

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

0 commit comments

Comments
 (0)