Skip to content
This repository has been archived by the owner on May 19, 2023. It is now read-only.

Testing snaglist for VRH merge #53

Open
rohennes opened this issue Apr 26, 2023 · 9 comments
Open

Testing snaglist for VRH merge #53

rohennes opened this issue Apr 26, 2023 · 9 comments

Comments

@rohennes
Copy link
Owner

rohennes commented Apr 26, 2023

  • modules/ai-adding-worker-nodes-to-cluster.adoc:84:1 need to account for callouts like //<1>
  • modules/builds-configuration-file.adoc:69:1 need to handle callouts that don't start with space
  • modules/cluster-logging-collector-log-forward-syslog.adoc:141:1 codeblock callouts at start of line inside the codeblock? IDK
  • modules/lvms-monitoring-logical-volume-manager-operator.adoc:40:1 handle tables with |=== delims, not just |====
  • modules/nodes-containers-sysctls-about.adoc:20:1: Listing block rules fires when - is used as an unordered list marker... this is actually due to a delimiter finishing on the last line of the file. Otherwise it's ok.
@rohennes
Copy link
Owner Author

rohennes commented Apr 26, 2023

FYI @aireilly
I can work on fixing these too (starting from the bottom of the list)

@aireilly
Copy link
Collaborator

Review the errors docs. Probably a number of the same issues. and there is prob more to find

@aireilly
Copy link
Collaborator

A dot star should fix the callouts issues

@rohennes
Copy link
Owner Author

rohennes commented Apr 27, 2023

  • modules/ztp-configuring-the-hub-cluster-to-use-unauthenticated-registries.adoc
    If a closing delimiter is on the last line of module, the rule triggers. I think it needs an /n at the end of the line for it to be counted? Occurs in multiple files.

  • modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc
    If a callout <1> is used in multiple places to indicate the same thing, it triggers the rule. Rule needs to handle repetition of numbers.

@rohennes
Copy link
Owner Author

Possible problem here. This snippet has three delimiters but is valid, right? Screws our rule?

[source,terminal]
----
$ cat <<EOF | oc apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: control-plane-<num>-bmc-secret <1> 
  namespace: openshift-machine-api
data:
  username: <base64_of_uid> <2>
  password: <base64_of_pwd> <3>
type: Opaque
---
apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  name: control-plane-<num> <1>
  namespace: openshift-machine-api
spec:
  automatedCleaningMode: disabled
  bmc:
    address: <protocol>://<bmc_ip> <4>
    credentialsName: control-plane-<num>-bmc-secret <1>
  bootMACAddress: <NIC1_mac_address> <5>
  bootMode: UEFI
  externallyProvisioned: false
  hardwareProfile: unknown
  online: true
EOF
----

@aireilly
Copy link
Collaborator

This last listing block delim error should be good now.

@rohennes
Copy link
Owner Author

rohennes commented Apr 28, 2023

@aireilly Is there a space in the matchingnumberedcallout rule for a reason? I think it's causing issues with callouts without a space before them, and callouts in this format //<1>

image

@rohennes
Copy link
Owner Author

Triggers validcodeblock rule

+
.Example output
[source,terminal]
----
---------------------------------------------------------------------------------
|                                GetCallerIdentity                              |
+-------------------------------------------------------------------------------+
|+-----------------------------------+-----------------------+-----------------+|
||      Account        |                Arn              |       UserID        ||
|+-----------------------------------+-----------------------+-----------------+|
||  <account_name>     |  arn:aws:iam<string>:user:name  |      <userID>       ||
|+-----------------------------------+-----------------------+-----------------+|
----
+
After completing these steps, install ROSA.

@aireilly
Copy link
Collaborator

listingblock_delim_regex := "^-{4,}$"

listingblock_delim_regex := "^-{4}$"

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants