From b5a9c74f10f4db78cd6ba51410b51aa279d34cc2 Mon Sep 17 00:00:00 2001 From: Moshe Immermam Date: Mon, 27 May 2024 14:39:07 +0300 Subject: [PATCH] chore: doc updates --- .vale.ini | 8 +- canary-checker/docs/scripting/cel.mdx | 4 +- canary-checker/docs/scripting/gotemplate.md | 7 +- styles/Flanksource/DateFormat.yml | 9 - styles/Flanksource/DigitalOceanTerms.yml | 23 - styles/Flanksource/Foreign.yml | 1 - .../DictateFeelings.yml | 0 .../{Flanksource => Strict}/FutureTense.yml | 0 .../config/vocabularies/Technical/accept.txt | 562 +++++++++--------- 9 files changed, 303 insertions(+), 311 deletions(-) delete mode 100644 styles/Flanksource/DateFormat.yml delete mode 100644 styles/Flanksource/DigitalOceanTerms.yml rename styles/{Flanksource => Strict}/DictateFeelings.yml (100%) rename styles/{Flanksource => Strict}/FutureTense.yml (100%) diff --git a/.vale.ini b/.vale.ini index fe99871b..a7a3f57c 100644 --- a/.vale.ini +++ b/.vale.ini @@ -4,8 +4,8 @@ Vocab = Technical Packages = Google, alex, Readability -[*.md] -BasedOnStyles = Vale, Flanksource, alex, Readability +[formats] +mdx = md -[*.mdx] -BasedOnStyles = Vale, Flanksource, alex, Readability +[*.md] +BasedOnStyles = Vale, Flanksource, alex diff --git a/canary-checker/docs/scripting/cel.mdx b/canary-checker/docs/scripting/cel.mdx index 629a63ab..7462bd14 100644 --- a/canary-checker/docs/scripting/cel.mdx +++ b/canary-checker/docs/scripting/cel.mdx @@ -2028,8 +2028,8 @@ length. ### .trim -Returns a new string which removes the leading and trailing whitespace in the -target string. The trim function uses the Unicode definition of whitespace +Returns a new string which removes the leading and trailing space. + The trim function uses the Unicode definition of space. which does not include the zero-width spaces. ```javascript diff --git a/canary-checker/docs/scripting/gotemplate.md b/canary-checker/docs/scripting/gotemplate.md index ca66ed08..62498010 100644 --- a/canary-checker/docs/scripting/gotemplate.md +++ b/canary-checker/docs/scripting/gotemplate.md @@ -1125,7 +1125,7 @@ A wrapper for Go's [`path.Split`](https://golang.org/pkg/path/#Split) function. ### ASCII -Generates a random string of a desired length, containing the set of printable characters from the 7-bit [ASCII](https://en.wikipedia.org/wiki/ASCII) set. This includes _space_ (' '), but no other whitespace characters. +Generates a random string of a desired length, containing the set of printable characters from the 7-bit [ASCII](https://en.wikipedia.org/wiki/ASCII) set. This includes _space_ (' '), but no other space characters. ```go {{ random.ASCII 8 }} // _woJ%D&K @@ -1509,8 +1509,7 @@ This wraps Go's [`strings.TrimPrefix`](https://golang.org/pkg/strings/#TrimPrefi ### TrimSpace -Trims a string by removing whitespace from the beginning and end of -the string. +Trims a string by removing space from the beginning and end. ```go {{ " \n\t foo" | strings.TrimSpace }} // foo @@ -1575,7 +1574,7 @@ See [Kebab Case on Wikipedia](https://en.wikipedia.org/wiki/Kebab_case) for more ### WordWrap -Inserts new line breaks into the input string so it ends up with lines that are at most `width` characters wide. The line-breaking algorithm is _naïve_ and _greedy_: lines are only broken between words (i.e. on whitespace characters), and no effort is made to "smooth" the line endings. When words that are longer than the desired width are encountered (e.g. long URLs), they are not broken up. Correctness is valued above line length. +Inserts new line breaks into the input string so it ends up with lines that are at most `width` characters wide. The line-breaking algorithm is _naïve_ and _greedy_: lines are only broken between words (i.e. on space characters), and no effort is made to "smooth" the line endings. When words that are longer than the desired width are encountered (e.g. long URLs), they are not broken up. Correctness is valued above line length. The line-break sequence defaults to `\n` (i.e. the LF/Line Feed character), regardless of OS. diff --git a/styles/Flanksource/DateFormat.yml b/styles/Flanksource/DateFormat.yml deleted file mode 100644 index d7dd8e91..00000000 --- a/styles/Flanksource/DateFormat.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: Use '1 January 1970' format, not '%s'. -link: https://docs.digitalocean.com/style/pdocs -ignorecase: true -level: error -nonword: true -tokens: - - '(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{1,2} ' - - '(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{1,2},? \d{4}' diff --git a/styles/Flanksource/DigitalOceanTerms.yml b/styles/Flanksource/DigitalOceanTerms.yml deleted file mode 100644 index 2ab9e3b9..00000000 --- a/styles/Flanksource/DigitalOceanTerms.yml +++ /dev/null @@ -1,23 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.digitalocean.com/style/digitalocean/products/ -ignorecase: false -level: error -action: - name: replace -swap: - 1-click [Aa]pp(?:|lication)[s]?: 1-Click App(lication) - 1-[Cc]lick app(?:|lication)[s]?: 1-Click App(lication) - 1-[Cc]licks: 1-Click App(lication) - DigitalOcean [Cc]ontainer registry: DigitalOcean Container Registry - DigitalOcean container [Rr]egistry: DigitalOcean Container Registry - DigitalOcean [Cc]ontrol panel: DigitalOcean Control Panel - DigitalOcean control [Pp]anel: DigitalOcean Control Panel - DigitalOcean [Dd]roplet console: DigitalOcean Droplet Console - '[Cc]loudWays': Cloudways - Cloud [Ww]ays': Cloudways - Cloudways academy: Cloudways Academy - Digital [Oo]cean: DigitalOcean - 'Digitalocean': DigitalOcean - 'digitalocean^(?:.com)': DigitalOcean - droplet[s]?: Droplet(s) diff --git a/styles/Flanksource/Foreign.yml b/styles/Flanksource/Foreign.yml index 5da5872f..f645ca0b 100644 --- a/styles/Flanksource/Foreign.yml +++ b/styles/Flanksource/Foreign.yml @@ -7,7 +7,6 @@ nonword: true action: name: replace swap: - '\b(?:eg|e\.g\.)[\s,]': for example '\b(?:ie|i\.e\.)[\s,]': that is '\b(?:viz\.)[\s,]': namely '\b(?:ergo)[\s,]': therefore diff --git a/styles/Flanksource/DictateFeelings.yml b/styles/Strict/DictateFeelings.yml similarity index 100% rename from styles/Flanksource/DictateFeelings.yml rename to styles/Strict/DictateFeelings.yml diff --git a/styles/Flanksource/FutureTense.yml b/styles/Strict/FutureTense.yml similarity index 100% rename from styles/Flanksource/FutureTense.yml rename to styles/Strict/FutureTense.yml diff --git a/styles/config/vocabularies/Technical/accept.txt b/styles/config/vocabularies/Technical/accept.txt index 06aa2d6b..3a4d1440 100644 --- a/styles/config/vocabularies/Technical/accept.txt +++ b/styles/config/vocabularies/Technical/accept.txt @@ -1,461 +1,487 @@ +(HTTP|http) +(HTTPS|https) [Aa]ccessor[s]? +[Aa]lertmanager [Aa]llowlist[s]? +[Aa]udiobook[s]? [Aa]utocommit [Aa]utodeploy +[Bb]ackoff +[Bb]lackhole(|s|d) +[Bb]lackholing +[Bb]lockchain +[Bb]oolean +[Bb]ootloader +[Bb]uildpack[s]? +[Bb]undler[s]? +[Bb]urstable +[Bb]ursty +[Cc]loudwatch +[Cc]odec(|s|'s)? +[Cc]omposability +[Cc]onfig +[Cc]utover[s]? +[Dd]atacenter[s]? +[Dd]atagram[s]? +[Dd]eclaratively +[Dd]enylist[s]? +[Dd]ev +[Ee]gress(|es|ed|ing) +[Ee]thernet +[Ff]ailover[s]? +[Ff]irewalld +[G]eospatial +[Gg]eocod(e|er|ing) +[Gg]ibibyte[s]? +[Gg]ithub +[Gg]itops +[Gg]rafana +[Hh]ardcod(e|ed|ing) +[Hh]ostname +[Ii]dempotence +[Ii]mpactful +[Jj][Mm]eter +[Jj][Uu]nit +[Jj]ournaling +[Kk]eepalive +[Kk]ey pair[s]? +[Kk]ubelet +[kK]ustomize +[Ll]abelSelector +[Ll]iveness +[Ll]ockfile[s]? +[Ll]ookup[s]? +[Ll]oopback +[Mm]akefiles? +[Mm]icroarchitectur(?:e|al) +[Mm]icroservice[s] +[Mm]ulticloud +[Nn]amespace +[Nn]etmask[s]? +[Oo]nboarding +[Oo]nnx +[Pp]arsable +[Pp]assthrough +[Pp]erformant +[Pp]ooler +[Pp]reauthorization +[Pp]reconfigured? +[Pp]refill[s]? +[Pp]repend(|s|ed|ing) +[Rr]clone +[Rr]ebalancing +[Rr]edeployment(s|'s)? +[Rr]edis +[Rr]eenabl(e|ed|ing) +[Rr]eprovision(|s|ed|ing) +[Rr]estic +[Rr]ollout +[Rr]outable +[Rr]untime[s]? +[Ss]erializable +[Ss]erverless +[Ss]hortcode[s]? +[Ss]ubcommand[s]? +[Ss]ubfolder[s]? +[Ss]ubnet(|s|work|works) +[Tt]axability +[Tt]emplated +[Tt]oolchain[s]? +[Tt]ooltip +[tTrivy] +[Uu]nassign(|s|ed) +[Uu]ncheck +[Uu]ncomment(|ed) +[Uu]ncompromised +[Uu]ndeploy(|ed) +[Uu]nderuse +[Uu]nencrypted +[Uu]nformatted +[Uu]nmanaged +[Uu]nmarshal(|led|ling) +[Uu]nmetered +[Uu]nmount +[Uu]npartitioned +[Uu]npatched +[Uu]nsetting +[Uu]nstage(|s|ed|ing) +[Uu]ntriggered +[Uu]ntrusted +[Uu]nversioned +[Vv]irtualized +[Ww]ebpack +[Yy][Aa][Mm][Ll] +[Zz]sh +accessKey ACL[s]? -[Aa]udiobook[s]? +aggs +sed +awk +dns|DNS +aws|AWS +[Nn]ewman +[Aa]lertmanager +alertname Algolia AMI[s]? Anchore Ansible API(|s|'s)? Aptfile +arkade arXiv +asciicast +Asciinema Authy autofill Axios +azuredevops|AzureDevops|azureDevops +[Aazure] Backblaze balancer's -[Bb]ackoff -[Bb]lackhole(|s|d) -[Bb]lackholing -[Bb]lockchain -[Bb]oolean -[Bb]ootloader -[Bb]uildpack[s]? -[Bb]undler[s]? -[Bb]ursty +basepath +[bB]itnami +[Bb]lackbox Bluehost +[Bb]ool(s)? Boto Btrfs -[Bb]urstable byobu CA[s]? CCM(?:|s|'s) -[Cc]odec(|s|'s)? -[Cc]omposability -[Cc]onfig -[Cc]utover[s]? CDN[s]? +CEL|cel Ceph Certbot +certificaterequest +certmanager cgroup[s]? +[Cc]hartmuseum chkrootkit ci CI CIDR[s]? +cifs|CIFS Citrix +classname CLI(|s|'s)? +Cloudprober +cloudsql|CloudSQL +cluster[Rr]ole +cluster[Rr]olebinding +CNCF CNCF's Comodo Conda +config[Mm]ap conformant -containerd +[Cc]ontainer[Dd] +controllerrevision +conv +coredns CoreDNS cPanel('s)? CPU[s]? +crashlooping +CRD's CRD[s]? -cron +[Cc]reateFields +[Cc]ron CSIDriver +customresourcedefinition CVEs? Cyberduck +data's Databricks Datadog -data's -[Dd]atacenter[s]? -[Dd]atagram[s]? -[Dd]eclaratively -[Dd]enylist[s]? -[Dd]ev +datasource Deepspeed +deleteTimeout +[Dd]ependabot +dependsOn DigiCert +distro Dockerfile[s]? dockershim -[Ee]gress(|es|ed|ing) -[Ee]thernet +Dynatrace +endpointslices Enom +Entra Esc ETag etcd Etherpad +exactreply +exitcode|exitCode Fastly -[Ff]ailover[s]? -[Ff]irewalld FFmpeg(|'s)? Figma Filebase +filestore +filestores FileZilla +FIPS +flanksource|Flanksource Flexify +fluentd +flux|Flux +fluxcd|FluxCD +folderFilter|FolderFilter FQDN[s]? +G[Bb]ps Galera Gandi -G[Bb]ps GBs +gcloud +gcpConnection +gcs|GCS gdown Gemfile -[G]eospatial -[Gg]eocod(e|er|ing) -[Gg]ibibyte[s]? GIF -GitHub +[Gg]itea +githubusercontent +[Gg]itops Godep +gojq +[Gg]olang +[Gg]omplate +[Gg]ooglechat +gosimple +[Gg]otemplate +[Gg]otify govendor GPG GPUs -Grafana Graphcore Gunicorn gVisor HAProxy Hasura HDD[s]? +helmrelease|HelmRelease Hetzner -[Hh]ardcod(e|ed|ing) -[Hh]ostname HPA[s]? -(HTTP|http) -(HTTPS|https) Icinga -[Ii]dempotence -[Ii]mpactful +inet Infiniband +ingressName inode[s]? IP[s]? ISP[s] Istio iwantmyname -Jamstack -[Jj]ournaling +Jamstack| journalctl -JPG -JWT +JPG|jpg +json|JSON +jsonArray|JSONArray +JSONNET|jsonnet +JSONPath|jsonpath +jwks|JWKS +JWT|jwt Kaniko Kartograph keyspace +KHTML Kibana -[Kk]eepalive -[Kk]ey pair[s]? -[Kk]ubelet Knative Kourier +[Kk]ratos +KSOPS Kube -kubeconfig -Kustomize +kubeadm +kubeconfig|KUBECONFIG +kubelet +Kuberhealthy +[Kk]ustomization(s)? +[Kk]ustomize Laravel +LDAPS Lerna LibriVox libvirt Lightsail Linkerd Linux -[Ll]iveness -[Ll]ockfile[s]? -[Ll]ookup[s]? -[Ll]oopback -Logstash +log[Ll]evel +Logstash|logstash Logtail logtalez Lua -[Mm]akefiles? -matplotlib M[Bb]ps +matplotlib Megaport +millicores +millis +Minio +minrecords +mkdirp MLOps -[Mm]icroarchitectur(?:e|al) -[Mm]icroservice[s] MNIST -MLOps -[Mm]ulticloud -MongoDB +MongoDB|mongodb +MTTR +multiline multiset[s]? -MySQL +myfile +MySQL|mysql Namecheap NAT[s]? netfilter Netplan -[Nn]amespace -[Nn]etmask[s]? +nodemetrics +nodeoutofmemory npm +NSSM +[Nn]tfy NumPy +nvarchar NVLink NVMe OAuth +oidc|OIDC OmniAuth Omnis Ooma -[Oo]nboarding -[Oo]nnx -OS +[Oo]pensearch +[Oo]psgenie +organisation +OS|os ownCloud +packetloss Papertrail +parent_id PayPal PDF(|s|'s)? pgAdmin PgBouncer Pgpool pgRouting +pgrst plaintext Plesk -PNG +plpgsql +PNG|png +podinfo +podmetrics +POSIX Postgre(s|SQL) -[Pp]arsable -[Pp]assthrough -[Pp]erformant -[Pp]ooler -[Pp]reauthorization -[Pp]reconfigured? -[Pp]refill[s]? -[Pp]repend(|s|ed|ing) +postgrest|PostgREST preload presigned +println Prisma +protobuf psql Punycode +[Pp]ushbullet PVC pydo +q qcow +querytype +rabbitmq Rackspace Razer +readyTimeout recommender -Redis +Redistributable Redli Redsmin +relname +[Rr]eplicaset repo(s|'s)? resolver's +resourcefilter reviewdog +[Rr]ocketchat +rolebinding Rollup -[Rr]clone -[Rr]ebalancing -[Rr]edeployment(s|'s)? -[Rr]eenabl(e|ed|ing) -[Rr]eprovision(|s|ed|ing) -[Rr]ollout -[Rr]outable -[Rr]untime[s]? rsync Rsyslog safetensor[s]? Sarama SDK[s]? +SDLC +secretKey +selfservice +service[aA]ccount(s)? +serviceMonitor +[Ss]houtrrr Skylake SLA[s]? +SLO's Slowloris Snyk Sourcegraph +squote SSD[s]? -[Ss]erializable -[Ss]erverless ssh-copy-id -[Ss]hortcode[s]? -[Ss]ubcommand[s]? -[Ss]ubfolder[s]? -[Ss]ubnet(|s|work|works) +sslmode +[Ss]tateful[Ss]et +[Ss]torageClass Streamlit +streetsidesoftware +struct +structs +subchart +subcomponent +substring sudo Supabase -SVG +SVG|svg +svix|SVIX syslog systemd Tekton -Terraform +[Tt]emplatable +[Tt]emplating +[Tt]erraform TLD[s] +tls|TLS tmux +toJSONPretty +topology_id traceroute Trilio -[Tt]axability -[Tt]emplated +[Tt]runc +tsdb +tsmerge TTL -[Tt]oolchain[s]? -[Tt]ooltip Twilio -tz -UI +tz|TZ +UI|ui +undeleted uninstallation +Unmarshaler UpCloud upsert[s] -URI -URL +URI|uri +URL|url +urldecode +urlencode UUID[s]? -[Uu]nassign(|s|ed) -[Uu]ncheck -[Uu]ncomment(|ed) -[Uu]ncompromised -[Uu]ndeploy(|ed) -[Uu]nderuse -[Uu]nencrypted -[Uu]nformatted -[Uu]nmanaged -[Uu]nmarshal(|led|ling) -[Uu]nmetered -[Uu]nmount -[Uu]npartitioned -[Uu]npatched -[Uu]nsetting -[Uu]nstage(|s|ed|ing) -[Uu]ntriggered -[Uu]ntrusted -[Uu]nversioned +valueFrom +varchar VDI[s]? Velero Vidhya virtualenv +visualstudio VM[s]? VMware vnStat VPC[s]? VPN[s]? +vsmarketplacebadge Vultr -[Vv]irtualized +webserver WebSocket -Wget -Wikidata +wget +ikidata WordPress -[Ww]ebpack +workqueue +X Xeon xrdp -YAML Zombieload -[Zz]sh -aggs -alertmanager -alertname -arkade -asciicast -Asciinema -azuredevops -basepath -Bitnami -blackbox -Bools -certificaterequest -certmanager -chartmuseum -cifs -classname -Cloudprober -cloudsql -clusterrole -clusterrolebinding -CNCF -configmap -containerd -controllerrevision -conv -coredns -crashlooping -CRD's -customresourcedefinition -datasource -distro -Dynatrace -endpointslices -Entra -exactreply -exitcode -filestore -filestores -FIPS -flanksource -fluentd -flux -fluxcd -folderfilter -gcloud -gitea -githubusercontent -gitops -gojq -gomplate -googlechat -gosimple -gotemplate -gotify -helmrelease -inet -jmeter -JSONNET -jwks -keyspace -KHTML -kratos -KSOPS -kubeadm -kubeconfig -kubelet -Kuberhealthy -kuebconfig -kustomization -Kustomizations -kustomize -LDAPS -loglevel -millicores -millis -Minio -minrecords -mkdirp -MTTR -myfile -nodemetrics -nodeoutofmemory -NSSM -ntfy -nvarchar -oidc -opensearch -opsgenie -organisation -packetloss -pgrst -plpgsql -podinfo -podmetrics -POSIX -postgrest -println -protobuf -psql -pushbullet -querytype -rabbitmq -Redistributable -relname -replicaset -replicset -resourcefilter -restic -rocketchat -rolebinding -SDLC -selfservice -serviceaccount -serviceaccounts -servicemonitor -shoutrrr -SLO's -squote -sslmode -statefulset -storageclass -streetsidesoftware -struct -structs -subchart -subcomponent -svix -templatable -templating -trivy -trunc -tsdb -tsmerge -Unmarshaler -urldecode -urlencode -varchar -visualstudio -vsmarketplacebadge -webserver -workqueue -X -zulip +[Zz]ulip