When documenting network-dependent features, explicitly specify all network configuration requirements including protocol support, certificate handling, and infrastructure setup. Users often encounter connectivity issues due to undocumented network prerequisites.
Include specific configuration examples and verification steps for:
Example documentation pattern:
# Network Requirements
!!! note
This feature requires HTTP/2 support. Verify your infrastructure supports HTTP/2.
# TLS Configuration (for self-signed certificates)
spec:
# Skip TLS validation for self-signed certificates
insecure: true
# Reference to trusted CA certificates
caRef:
configMapName: argocd-tls-certs-cm
key: azure-devops-ca
# Ingress Configuration
apiVersion: networking.k8s.io/v1
kind: Ingress
spec:
rules:
- host: cd.apps.argoproj.io
http:
paths:
- path: /api/webhook
pathType: Prefix
backend:
service:
name: argocd-applicationset-controller
port:
number: 7000
This prevents user frustration from undocumented network dependencies and reduces support burden from connectivity-related issues.
Enter the URL of a public GitHub repository