ConventionsΒΆ

Example ConsistencyΒΆ

Examples should be consistent throughout the documentation. We should standardize on a set of values/examples used, e.g.:

  • Example domains: example.com, example.org, example.net
  • Example hosts: foo.example.com, bar.example.com
  • Example IP addresses: 192.0.2.0/24 (pick from the range 192.0.2.0 - 192.0.2.255)
  • Example plugins: FIXME
  • Example datasources: FIXME

RFC2606 details which hostnames are reserved for such usage.

RFC3330 details special-use IPv4 addresses.