Merge pull request #549 from robscott/docs-special-chars

Fixing API Reference Doc Generation

Author: k8s-ci-robot

Makefile

@@ -69,7 +69,7 @@ verify:
 .PHONY: docs
 docs:
 	# Generate API docs first
-	./hack/api-docs/generate.sh docs-src/spec.md
+	./hack/api-docs/generate.sh docs-src/spec.html
 	# The docs image must be built locally until issue #141 is fixed.
 	docker build --tag k8s.gcr.io/gateway-api-mkdocs:latest -f mkdocs.dockerfile .
 	$(MAKE) -f docs.mk

apis/v1alpha1/gateway_types.go

@@ -138,7 +138,7 @@ type GatewaySpec struct {
 // validating webhook.
 type Listener struct {
 	// Hostname specifies the virtual hostname to match for protocol types that
-	// define this concept. When unspecified, "", or "*", all hostnames are
+	// define this concept. When unspecified, "", or `*`, all hostnames are
 	// matched. This field can be omitted for protocols that don't require
 	// hostname based matching.
 	//
@@ -151,8 +151,8 @@ type Listener struct {
 	//
 	// Hostname can be "precise" which is a domain name without the terminating
 	// dot of a network host (e.g. "foo.example.com") or "wildcard", which is a
-	// domain name prefixed with a single wildcard label (e.g. "*.example.com").
-	// The wildcard character '*' must appear by itself as the first DNS label
+	// domain name prefixed with a single wildcard label (e.g. `*.example.com`).
+	// The wildcard character `*` must appear by itself as the first DNS label
 	// and matches only a single label.
 	//
 	// Support: Core
@@ -718,7 +718,7 @@ const (
 
 	// ListenerReasonHostnameConflict is used when the Listener conflicts with
 	// hostnames in other Listeners. For example, this reason would be used when
-	// multiple Listeners on the same port use "*" in the hostname field.
+	// multiple Listeners on the same port use `*` in the hostname field.
 	ListenerReasonHostnameConflict ListenerConditionReason = "HostnameConflict"
 
 	// ListenerReasonProtocolConflict is used when multiple

apis/v1alpha1/httproute_types.go

@@ -69,10 +69,10 @@ type HTTPRouteSpec struct {
 	//
 	// Hostname can be "precise" which is a domain name without the terminating
 	// dot of a network host (e.g. "foo.example.com") or "wildcard", which is
-	// a domain name prefixed with a single wildcard label (e.g. "*.example.com").
-	// The wildcard character '*' must appear by itself as the first DNS
+	// a domain name prefixed with a single wildcard label (e.g. `*.example.com`).
+	// The wildcard character `*` must appear by itself as the first DNS
 	// label and matches only a single label.
-	// You cannot have a wildcard label by itself (e.g. Host == "*").
+	// You cannot have a wildcard label by itself (e.g. Host == `*`).
 	// Requests will be matched against the Host field in the following order:
 	// 1. If Host is precise, the request matches this rule if
 	//    the http host header is equal to Host.

apis/v1alpha1/tlsroute_types.go

@@ -89,10 +89,10 @@ type TLSRouteMatch struct {
 	//
 	// SNI can be "precise" which is a domain name without the terminating
 	// dot of a network host (e.g. "foo.example.com") or "wildcard", which is
-	// a domain name prefixed with a single wildcard label (e.g. "*.example.com").
-	// The wildcard character '*' must appear by itself as the first DNS label
+	// a domain name prefixed with a single wildcard label (e.g. `*.example.com`).
+	// The wildcard character `*` must appear by itself as the first DNS label
 	// and matches only a single label. You cannot have a wildcard label by
-	// itself (e.g. Host == "*").
+	// itself (e.g. Host == `*`).
 	//
 	// Requests will be matched against the Host field in the following order:
 	//