Skip to content

Commit

Permalink
move guides into versioned documentation (projectcontour#4977)
Browse files Browse the repository at this point in the history
Closes projectcontour#4396.

Signed-off-by: Steve Kriss <krisss@vmware.com>
  • Loading branch information
skriss authored and vmw-yingy committed Feb 28, 2023
1 parent adaa952 commit e6d0fd4
Show file tree
Hide file tree
Showing 50 changed files with 6,589 additions and 53 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ generate-api-docs:
.PHONY: generate-metrics-docs
generate-metrics-docs:
@echo "Generating metrics documentation..."
@cd site/content/guides/metrics && rm -f *.md && go run ../../../../hack/generate-metrics-doc.go
@cd site/content/docs/main/guides/metrics && rm -f *.md && go run ../../../../../../hack/generate-metrics-doc.go

.PHONY: generate-go
generate-go:
Expand Down
1 change: 1 addition & 0 deletions changelogs/unreleased/4977-skriss-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Guides are now versioned along with the rest of Contour's documentation. You can find them listed in the menu on the left-hand side of https://projectcontour.io/docs.
2 changes: 1 addition & 1 deletion site/content/docs/main/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ If you encounter issues review the [troubleshooting][5] page, [file an issue][6]
[6]: https://github.com/projectcontour/contour/issues
[7]: https://kubernetes.slack.com/messages/contour
[8]: /resources/philosophy
[9]: /guides/gateway-api
[9]: guides/gateway-api
[10]: /docs/{{< param version >}}/config/ingress
2 changes: 1 addition & 1 deletion site/content/docs/main/config/client-authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,4 @@ context field of authorization policy for the route.
[4]: api/#projectcontour.io/v1.UpstreamValidation
[5]: api/#projectcontour.io/v1.AuthorizationServer
[6]: api/#projectcontour.io/v1.AuthorizationPolicy
[7]: /guides/external-authorization.md
[7]: guides/external-authorization.md
2 changes: 1 addition & 1 deletion site/content/docs/main/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ connects to Contour:


[1]: {{< param github_url>}}/tree/{{< param version >}}/examples/contour/01-contour-config.yaml
[2]: /guides/structured-logs
[2]: guides/structured-logs
[3]: https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/
[4]: https://golang.org/pkg/time/#ParseDuration
[5]: https://godoc.org/github.com/projectcontour/contour/internal/envoy#DefaultFields
Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/main/deploy-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,17 +363,17 @@ $ kubectl delete ns contour-operator
[1]: #running-without-a-kubernetes-loadbalancer
[2]: {{< param github_url>}}/tree/{{< param version >}}/examples/render/contour.yaml
[3]: #host-networking
[4]: /guides/proxy-proto.md
[4]: guides/proxy-proto.md
[5]: https://github.com/kubernetes-up-and-running/kuard
[7]: {{< param github_url>}}/tree/{{< param version >}}/examples/contour/02-service-envoy.yaml
[8]: /getting-started
[9]: config/fundamentals.md
[10]: /guides/deploy-aws-nlb.md
[10]: guides/deploy-aws-nlb.md
[11]: redeploy-envoy.md
[12]: https://github.com/projectcontour/contour-operator
[13]: https://projectcontour.io/resources/deprecation-policy/
[14]: {{< param github_url>}}/tree/{{< param version >}}/examples/render/contour-deployment.yaml
[15]: /resources/upgrading/
[16]: https://projectcontour.io/getting-started/#option-3-contour-gateway-provisioner-alpha
[17]: {{< param github_url>}}/tree/{{< param version >}}/examples/contour
[18]: /guides/gateway-api/#next-steps
[18]: guides/gateway-api/#next-steps
9 changes: 9 additions & 0 deletions site/content/docs/main/guides/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Guides
description: Contour Resources
id: guides
---
## Getting things done with Contour

This page contains links to articles on configuring specific Contour features.

Loading

0 comments on commit e6d0fd4

Please sign in to comment.