Skip to content

Commit e743aa8

Browse files
authored
Merge pull request #1186 from robscott/docs-fixes
Fixing docs to have subheaders again, removing custom alignment
2 parents 3805bf6 + 6239dcf commit e743aa8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+94
-99
lines changed

examples/v1alpha1/basic-http.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/api-types/httproute.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/api-types/httproute.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: GatewayClass
55
metadata:

examples/v1alpha1/basic-tcp.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/tcp.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/tcp.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: GatewayClass
55
metadata:

examples/v1alpha1/cross-namespace-routing/gateway.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/multiple-ns.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/multiple-ns.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: Gateway
55
metadata:

examples/v1alpha1/cross-namespace-routing/site-route.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/multiple-ns.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/multiple-ns.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/cross-namespace-routing/store-route.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/multiple-ns.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/multiple-ns.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/http-filter.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/api-types/httproute.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/api-types/httproute.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: GatewayClass
55
metadata:

examples/v1alpha1/http-routing/bar-httproute.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/http-routing.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/http-routing.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/http-routing/foo-httproute.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/http-routing.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/http-routing.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/http-routing/gateway.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/http-routing.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/http-routing.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: Gateway
55
metadata:

examples/v1alpha1/http-trafficsplit.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/api-types/httproute.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/api-types/httproute.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: GatewayClass
55
metadata:

examples/v1alpha1/simple-gateway/gateway.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/traffic-splitting.md
3-
## - site-src/v1alpha1/guides/simple-gateway.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/traffic-splitting.md
3+
#$ - site-src/v1alpha1/guides/simple-gateway.md
44
apiVersion: networking.x-k8s.io/v1alpha1
55
kind: Gateway
66
metadata:

examples/v1alpha1/simple-gateway/httproute.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/simple-gateway.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/simple-gateway.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/tls-basic.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/tls.md
3-
## - site-src/v1alpha1/api-types/httproute.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/tls.md
3+
#$ - site-src/v1alpha1/api-types/httproute.md
44
apiVersion: networking.x-k8s.io/v1alpha1
55
kind: Gateway
66
metadata:

examples/v1alpha1/tls-cert-in-route.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/tls.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/tls.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: Gateway
55
metadata:

examples/v1alpha1/traffic-splitting/simple-split.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/traffic-splitting.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/traffic-splitting.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/traffic-splitting/traffic-split-1.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/traffic-splitting.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/traffic-splitting.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/traffic-splitting/traffic-split-2.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/traffic-splitting.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/traffic-splitting.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/traffic-splitting/traffic-split-3.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/traffic-splitting.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/traffic-splitting.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: HTTPRoute
55
metadata:

examples/v1alpha1/upstream-tls.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/tls.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/tls.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: BackendPolicy
55
metadata:

examples/v1alpha1/wildcard-tls-gateway.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha1/guides/tls.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha1/guides/tls.md
33
apiVersion: networking.x-k8s.io/v1alpha1
44
kind: Gateway
55
metadata:

examples/v1alpha2/basic-http.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/api-types/httproute.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/api-types/httproute.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: GatewayClass
55
metadata:

examples/v1alpha2/basic-tcp.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/tcp.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/tcp.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: Gateway
55
metadata:

examples/v1alpha2/cross-namespace-routing/0-namespaces.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/multiple-ns.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/multiple-ns.md
33
apiVersion: v1
44
kind: Namespace
55
metadata:

examples/v1alpha2/cross-namespace-routing/gateway.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/multiple-ns.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/multiple-ns.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: Gateway
55
metadata:

examples/v1alpha2/cross-namespace-routing/site-route.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/multiple-ns.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/multiple-ns.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/cross-namespace-routing/store-route.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/multiple-ns.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/multiple-ns.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/http-filter.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/api-types/httproute.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/api-types/httproute.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/http-route-attachment/gateway-namespaces.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/concepts/api-overview.md
1+
#$ Used in:
2+
#$ - site-src/concepts/api-overview.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: Gateway
55
metadata:

examples/v1alpha2/http-route-attachment/gateway-strict.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/concepts/api-overview.md
1+
#$ Used in:
2+
#$ - site-src/concepts/api-overview.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: Gateway
55
metadata:

examples/v1alpha2/http-route-attachment/httproute.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/concepts/api-overview.md
1+
#$ Used in:
2+
#$ - site-src/concepts/api-overview.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/http-routing/bar-httproute.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/http-routing.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/http-routing.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/http-routing/foo-httproute.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/http-routing.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/http-routing.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/http-routing/gateway.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/http-routing.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/http-routing.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: Gateway
55
metadata:

examples/v1alpha2/reference-grant.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Used in:
2-
## - site-src/concepts/security-model.md
3-
## - site-src/blog/2021/introducing-v1alpha2.md
1+
#$ Used in:
2+
#$ - site-src/concepts/security-model.md
3+
#$ - site-src/blog/2021/introducing-v1alpha2.md
44
apiVersion: gateway.networking.k8s.io/v1alpha2
55
kind: ReferenceGrant
66
metadata:

examples/v1alpha2/simple-gateway/gateway.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/traffic-splitting.md
3-
## - site-src/v1alpha2/guides/simple-gateway.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/traffic-splitting.md
3+
#$ - site-src/v1alpha2/guides/simple-gateway.md
44
apiVersion: gateway.networking.k8s.io/v1alpha2
55
kind: Gateway
66
metadata:

examples/v1alpha2/simple-gateway/httproute.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/simple-gateway.md
3-
## - site-src/blog/2021/introducing-v1alpha2.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/simple-gateway.md
3+
#$ - site-src/blog/2021/introducing-v1alpha2.md
44
apiVersion: gateway.networking.k8s.io/v1alpha2
55
kind: HTTPRoute
66
metadata:

examples/v1alpha2/tls-basic.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/tls.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/tls.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: Gateway
55
metadata:

examples/v1alpha2/tls-cert-cross-namespace.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/tls.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/tls.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: Gateway
55
metadata:

examples/v1alpha2/traffic-splitting/simple-split.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/traffic-splitting.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/traffic-splitting.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/traffic-splitting/traffic-split-1.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/traffic-splitting.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/traffic-splitting.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/traffic-splitting/traffic-split-2.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/traffic-splitting.md
3-
## - site-src/v1alpha2/api-types/httproute.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/traffic-splitting.md
3+
#$ - site-src/v1alpha2/api-types/httproute.md
44
apiVersion: gateway.networking.k8s.io/v1alpha2
55
kind: HTTPRoute
66
metadata:

examples/v1alpha2/traffic-splitting/traffic-split-3.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/traffic-splitting.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/traffic-splitting.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: HTTPRoute
55
metadata:

examples/v1alpha2/wildcard-tls-gateway.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Used in:
2-
## - site-src/v1alpha2/guides/tls.md
1+
#$ Used in:
2+
#$ - site-src/v1alpha2/guides/tls.md
33
apiVersion: gateway.networking.k8s.io/v1alpha2
44
kind: Gateway
55
metadata:

mkdocs.yml

+1-3
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,12 @@ theme:
1414
- navigation.tabs
1515
- navigation.top
1616
edit_uri: edit/master/site-src/
17-
extra_css:
18-
- css/extra.css
1917
plugins:
2018
- search
2119
- awesome-pages
2220
- macros:
2321
include_dir: examples
24-
j2_line_comment_prefix: "##"
22+
j2_line_comment_prefix: "#$"
2523
markdown_extensions:
2624
- admonition
2725
- meta

requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Click==7.0
22
htmlmin==0.1.12
33
Jinja2==2.11.1
4-
jsmin==2.2.2
4+
jsmin==3.0.0
55
livereload==2.6.1
66
Markdown==3.3.4
77
MarkupSafe==1.1.1

site-src/css/extra.css

-3
This file was deleted.

0 commit comments

Comments
 (0)