.textlintrc.json

{
  "plugins": {
    "@textlint/text": {
      "extensions": [".yml"]
    }
  },
  "filters": {
    "comments": {
      "disablingComment": "prettier-ignore-start",
      "enablingComment": "prettier-ignore-end"
    },
    "allowlist": {
      "allow": [
        "/{{%.*%}}/",
        "/<http://.*>/",
        "medium.com/opentelemetry",
        "github.com/open-telemetry",
        "#opentelemetry",
        "/^(?:language|repo): .*$/m",
        "/tags:([\\n\\r\\s]*-[\\s\\S]*?[\\n\\r]+)*/m"
      ]
    }
  },
  "rules": {
    "terminology": {
      "defaultTerms": false,
      "skip": [],
      "terms": [
        "Ajax",
        "Apache",
        "API",
        "AWS",
        "Azure",
        "CNCF",
        "eBPF",
        "ECMAScript",
        "Elixir",
        "Erlang",
        "GCP",
        "GitHub",
        "gRPC",
        "GraphQL",
        "ID",
        "iOS",
        "HTTP",
        "HTTPS",
        "Jaeger",
        "Java",
        "JavaScript",
        "Jetty",
        "JMX",
        "JSON",
        "K8s",
        "Kafka",
        "KubeCon",
        "Kubernetes",
        "MacBook",
        "macOS",
        "MongoDB",
        "MySQL",
        "NGINX",
        "NDJSON",
        "OK",
        "OpenSearch",
        "OpenTelemetry Collector",
        "OTel",
        "OTEP",
        "PDF",
        "Phoenix",
        "PHP",
        "Python",
        "PostgreSQL",
        "protobuf",
        "Rails",
        "Redis",
        "Ruby",
        "Rust",
        "SemVer",
        "SDK",
        "SQL",
        "SQLite",
        "Swift",
        "Thanos",
        "Traefik",
        "TypeScript",
        "URL",
        "WordPress",
        "YouTube",
        "Zend",
        "Zipkin",
        ["\\.net", ".NET"],
        ["(?<=\\.)net\\b", "NET"],
        ["3rd[- ]party", "third-party"],
        ["cpp", "C++"],
        ["dotnet", ".NET"],
        ["ebpf", "eBPF"],
        ["HTTP[ /]?2(?:\\.0)?", "HTTP/2"],
        ["he or she", "they"],
        ["he/she", "they"],
        ["\\(s\\)he", "they"],
        ["id['’]?s", "IDs"],
        ["mac ?os", "macOS"],
        ["meta[- ]data", "metadata"],
        ["nd-?json", "NDJSON"],
        ["node\\.?js", "Node.js"],
        ["open-source", "open source"],
        ["open[- ]?telemetry", "OpenTelemetry"],
        ["os x", "macOS"],
        ["postgres", "PostgreSQL"],
        ["psr[ -]?([0-9]+)", "PSR-$1"],
        ["react[ .]js", "React"],
        ["regexp?(s)?", "regular expression$1"],
        ["repo\\b", "repository"],
        ["repos", "repositories"],
        ["screen[- ]shot(s)?", "screenshot$1"],
        ["time[- ]stamp(s)?", "timestamp$1"],
        ["uid['’]?s", "UIDs"]
      ]
    }
  }
}