h1-h6_sentence_case.yml

extends: capitalization
message: "'%s' should be in sentence case"
level: error
scope:
  - heading.h1
  - heading.h2
  - heading.h3
  - heading.h4
  - heading.h5
  - heading.h6
match: $sentence
exceptions:
  - '^(\d+\.) [A-Z]\w+' # Allow numbered headings. Example: "1. Install the thing"
  - '^(Agent|Build|Job) ([A-Z]\w+(ed|ing)|Lost)$' # Exceptions for /pages/integrations/amazon_eventbridge.md
  - '^(Step|Method) \d: [A-Z]\w+' # Allow caps after colon. Examples: "Step 3: Do the thing", "Method 2: Deploy keys"
  - 2FA
  - ADFS
  - Advanced Queue Metrics
  - API
  - APM
  - AWS
  - AWS Elastic Container Registry
  - Amazon
  - Amazon EventBridge
  - Amazon Web Services
  - AMI
  - ANSI
  - API(s)
  - Artifactory
  - Audit Event Logged
  - Auto Scaling
  - AWS Console
  - AWS Lambda
  - AWS License Manager
  - AWS Secrets Manager
  - AWS Systems Manager Session Manager
  - Azure AD
  - Azure Active Directory
  - Azure Blob
  - Bash
  - Bazel
  - Bamboo
  - Basecamp Campfire
  - Bitbucket
  - Bitbucket Server
  - BUILD_AND_READ
  - Buildkite
  - Buildkite Agent
  - Buildkite Agents
  - Buildkite Package Registries
  - Buildkite Pipelines
  - buildkite-agent
  - BuildNotify
  - BuildReactor
  - C\+\+
  - CCMenu
  - CCTray
  - CentOS
  - CI
  - CircleCI
  - CLI
  - CloudFormation
  - Cloudsmith
  - CloudWatch
  - CloudWatch Logs
  - CORS
  - CSS
  - Datadog
  - Debian
  - Docker
  - Docker Compose
  - Docker Hub
  - EC2
  - Elastic
  - Elastic CI Stack
  - Everyone
  - ExUnit
  - FAQs
  - FreeBSD
  - G Suite
  - Git
  - GitHub
  - GitHub Actions
  - GitHub App
  - GitHub Enterprise
  - GitHub Enterprise Server
  - GitLab
  - GitLab Community
  - GitLab Enterprise
  - Go
  - Google Chrome
  - Google Cloud
  - Google Cloud Functions
  - Google Cloud Identity
  - Google Cloud Platform
  - Google Cloud Storage
  - Google Compute Engine
  - Google Container Registry
  - Google Kubernetes Engine
  - Google Workspace
  - GraphQL
  - Heroku
  - HMAC
  - HTTP
  - IAM
  - ID
  - IdP # TODO: unabbreviate this in headings
  - IDs
  - IronWorker
  - Installation
  - JavaScript
  - Jenkins
  - JFrog
  - Jest
  - JSON
  - JUnit
  - KMS
  - Kubernetes
  - Linux
  - M1
  - Mac
  - macOS
  - Markdown
  - minitest
  - NET
  - Node.js
  - OIDC
  - Okta
  - OneLogin
  - OpenTelemetry
  - OS X
  - Package Registries
  - PagerDuty
  - Phabricator
  - pipeline.artifacts_read.pipeline
  - pipeline.trigger_build.pipeline
  - pipeline.yml
  - PowerShell
  - pytest
  - QA
  - READ_ONLY
  - Red Hat
  - Red Hat Enterprise Linux
  - Registry Configuration
  - REST
  - RSpec
  - SAML
  - SCIM
  - Slack
  - SLSA
  - S3
  - SSH
  - SSO
  - Test Engine
  - Test Engine Client
  - TESTOWNER
  - Ubuntu
  - URL
  - URL(s)
  - UUID
  - VPC
  - VPN
  - Windows
  - Windows Subsystem for Linux 2
  - Xcode
  - XCTest
  - XML
  - YAML