Skip to content

Commit d599737

Browse files
committed
added ascidoctorconfig and vale.ini file to experiement with some settings
1 parent 79adb50 commit d599737

File tree

2 files changed

+140
-0
lines changed

2 files changed

+140
-0
lines changed

.asciidoctorconfig

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
:data-uri:
2+
:icons:
3+
:experimental:
4+
5+
//:toc: macro
6+
//:toc-title:
7+
:imagesdir: static/images
8+
:includedir: modules
9+
:prewrap!:
10+
//Solution name
11+
:rh-solution-name: Validated Patterns
12+
:solution-name-upstream: Hybrid Cloud Patterns
13+
//:solution-version: Update later when we start using versioned releases
14+
//Patterns
15+
:aeg-pattern: Ansible Edge GitOps pattern
16+
:aeg: Ansible Edge GitOps
17+
:ie-pattern: Industrial Edge pattern
18+
:ie: Industrial Edge
19+
:mcg-pattern: Multicloud GitOps pattern
20+
:mcg: multicloud GitOps
21+
:med-pattern: Medical Diagnosis pattern
22+
:med: medical diagnosis
23+
:multi-devsec-pattern: Multi-cluster DevSecOps pattern
24+
:multi-devsec: multi-cluster DevSecOps
25+
//Operators
26+
:validated-patterns-op: Validated Patterns Operator
27+
:grafana-op: Grafana Operator
28+
:eso-op: External Secrets Operator
29+
//OpenShift
30+
:rh-ocp: Red Hat OpenShift Container Platform
31+
:ocp: OpenShift Container Platform
32+
:ocp-version: 4.12
33+
:ocp-registry: OpenShift image registry
34+
//Single node and 3-node OpenShift
35+
:sno: single-node OpenShift
36+
:sno-first: Single-node OpenShift
37+
:3no: three-node OpenShift
38+
:3no-first: Three-node OpenShift
39+
//OpenShift Platform Plus
40+
:rh-opp: Red Hat OpenShift Platform Plus
41+
:opp: OpenShift Platform Plus
42+
//openshift virtualization (cnv)
43+
:VirtProductName: OpenShift Virtualization
44+
//Ansible:
45+
:rh-ansible: Red Hat Ansible Automation Platform
46+
:ansible: Ansible Automation Platform
47+
//GitOps
48+
:rh-gitops: Red Hat OpenShift GitOps
49+
:rh-gitops-short: OpenShift GitOps
50+
//CoreOS
51+
:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
52+
:op-system-short: RHCOS
53+
:op-system-lowercase: rhcos
54+
//RHEL
55+
:rhel-first: Red Hat Enterprise Linux (RHEL)
56+
:rhel-short: RHEL
57+
//:op-system-version: 8.x
58+
//Console icons
59+
:rh-app-icon: image:red-hat-applications-menu-icon.jpg[title="Red Hat applications"]
60+
:kebab: image:kebab.png[title="Options menu"]
61+
:rh-openstack-first: Red Hat OpenStack Platform (RHOSP)
62+
:openstack-short: RHOSP
63+
//Assisted Installer
64+
:ai-full: Assisted Installer
65+
:ai-version: 2.3
66+
//Cluster Manager
67+
:cluster-manager-first: Red Hat OpenShift Cluster Manager
68+
:cluster-manager: OpenShift Cluster Manager
69+
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager Hybrid Cloud Console]
70+
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
71+
:insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Insights Advisor]
72+
:hybrid-console-first: Red Hat Hybrid Cloud Console
73+
:hybrid-console: Hybrid Cloud Console
74+
//ACM
75+
:rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM)
76+
:rh-rhacm: RHACM
77+
//:rh-rhacm-version: 2.5
78+
//ACS
79+
:rh-acs-first: Red Hat Advanced Cluster Security for Kubernetes
80+
81+
:cert-manager-operator: cert-manager Operator for Red Hat OpenShift
82+
:secondary-scheduler-operator-full: Secondary Scheduler Operator for Red Hat OpenShift
83+
:secondary-scheduler-operator: Secondary Scheduler Operator
84+
:rh-virtualization-first: Red Hat Virtualization (RHV)
85+
:rh-virtualization: RHV
86+
:rh-virtualization-engine-name: Manager
87+
//gitops
88+
:gitops-title: Red Hat OpenShift GitOps
89+
:gitops-shortname: GitOps
90+
:gitops-ver: 1.1
91+
//pipelines
92+
:rh-pipelines-first: Red Hat OpenShift Pipelines
93+
:pipelines-short: OpenShift Pipelines
94+
:pipelines-ver: pipelines-1.9
95+
:tekton-chains: Tekton Chains
96+
:tekton-hub: Tekton Hub
97+
:pac: Pipelines as Code
98+
//AMQ
99+
:rh-amq-first: Red Hat AMQ
100+
:rh-amq-short: RHAMQ
101+
//Runtimes
102+
:rh-runtime: Red Hat Runtimes
103+
//Data foundation
104+
:rh-ocp-data-first: Red Hat OpenShift Data Foundation
105+
:rh-ocp-data-short: OpenShift Data Foundation
106+
//Serverless
107+
:rh-serverless-first: Red Hat OpenShift Serverless
108+
:serverless-short: OpenShift Serverless
109+
:ServerlessOperatorName: OpenShift Serverless Operator
110+
:FunctionsProductName: OpenShift Serverless Functions
111+
//Quay
112+
:rh-quay: Red Hat Quay
113+
:quay-short: Quay
114+
// Red Hat Quay Container Security Operator
115+
:rhq-cso: Red Hat Quay Container Security Operator
116+
//Cloud platforms
117+
:AWS: Amazon Web Services (AWS)
118+
:GCP: Google Cloud Platform (GCP)
119+
:Azure: Microsoft Azure

.vale.ini

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
StylesPath = .vale/styles
2+
3+
MinAlertLevel = suggestion
4+
5+
Packages = RedHat, AsciiDoc
6+
7+
IgnoredScopes = code, tt, img, url, a, body.id
8+
9+
SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock
10+
11+
# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
12+
[[!.]*.adoc]
13+
BasedOnStyles = RedHat, AsciiDoc
14+
15+
# Optional: pass doc attributes to asciidoctor before linting
16+
#[asciidoctor]
17+
#openshift-enterprise = YES
18+
19+
# Disabling rules (NO)
20+
RedHat.ReleaseNotes = NO
21+

0 commit comments

Comments
 (0)