Skip to content

Commit

Permalink
site: Fixup RateLimiting Guide & some other links (#3783)
Browse files Browse the repository at this point in the history
Fixes up the ratelimiting guide's links along with some other
links in the SITE_CONTRIBUTION, and getting started guide.
Also removes duplicate github url from config.

Updates #3712

Signed-off-by: Steve Sloka <slokas@vmware.com>
  • Loading branch information
stevesloka committed Jun 8, 2021
1 parent ee3e737 commit 1ddb0fb
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 10 deletions.
2 changes: 1 addition & 1 deletion SITE_CONTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Additionally, the above method will not follow any permalink changes or page-spe

**Linking to the project contour GitHub repo:**

The GitHub metadata plugin populates Jekyll variables with data from GitHub during build. When inserting a link to the Project Contour repository, use the prefix `{{site.github.repository_url}}`.
The GitHub metadata plugin populates Jekyll variables with data from GitHub during build. When inserting a link to the Project Contour repository, use the prefix `{{< param github_url >}}`.

A full list of variables can be found in the [jekyll-github-metadata documentation][4].

Expand Down
1 change: 0 additions & 1 deletion site/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ params:
twitter_url: "https://twitter.com/projectcontour"
github_url: "https://github.com/projectcontour/contour"
slack_url: "https://kubernetes.slack.com/messages/contour"
github_base_url: "https://github.com/projectcontour/contour"
latest_release_tag_name: v1.16.0
use_advanced_docs: true
docs_right_sidebar: true
Expand Down
2 changes: 1 addition & 1 deletion site/content/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ If you encounter issues, review the Troubleshooting section of [the docs][3], [f
[2]: /docs/{{< param docs_latest >}}/config/fundamentals
[3]: /docs/{{< param docs_latest >}}
[4]: {{< ref "resources/faq.md" >}}
[6]: {{site.github.repository_url}}/issues
[6]: {{< param github_url >}}/issues
[9]: https://github.com/kubernetes-up-and-running/kuard
[10]: https://kubernetes.io/docs/concepts/services-networking/service
[11]: https://kubernetes.io/docs/concepts/services-networking/ingress
Expand Down
2 changes: 1 addition & 1 deletion site/content/guides/fips.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The critical communication paths and how they are set up to be FIPS compliant ar
[5]: https://hub.docker.com/r/projectcontour/contour
[6]: https://www.gnu.org/software/make/
[7]: https://www.docker.com/
[8]: {{site.github.repository_url}}/blob/main/Dockerfile
[8]: {{< param github_url >}}/blob/main/Dockerfile
[9]: https://hub.docker.com/r/goboring/golang/
[10]: https://go.googlesource.com/go/+/dev.boringcrypto/misc/boring/README.md#version-strings
[11]: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl.html#fips-140-2
Expand Down
8 changes: 4 additions & 4 deletions site/content/guides/global-rate-limiting.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,12 +424,12 @@ For more information, see the [Contour rate limiting documentation][7] and the [
The YAML used in this guide is available [in the Contour repository][9].
[1]: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/other_features/global_rate_limiting
[2]: /docs/{{site.latest}}/deploy-options/#kind
[2]: /docs/{{< param docs_latest >}}/deploy-options/#kind
[3]: https://projectcontour.io/getting-started/#option-1-quickstart
[4]: https://github.com/envoyproxy/ratelimit
[5]: https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/ratelimit/v3/rls.proto
[6]: https://github.com/envoyproxy/ratelimit#configuration
[7]: /docs/{{site.latest}}/config/rate-limiting/
[8]: /docs/{{site.latest}}/config/api/
[9]: {{site.github.repository_url}}/tree/main/examples/ratelimit
[7]: /docs/{{< param docs_latest >}}/config/rate-limiting/
[8]: /docs/{{< param docs_latest >}}/config/api/
[9]: {{< param github_url>}}/tree/main/examples/ratelimit
[10]: https://github.com/lyft/goruntime
4 changes: 2 additions & 2 deletions site/themes/contour/layouts/partials/docs-right-bar.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
{{ if (or .IsNode .IsPage) }}
{{ $issueBody := printf "**On Page:** [%s](%s)" .Title .Permalink | htmlEscape }}
{{ $issueQuery := (querify "body" $issueBody) }}
<li><a href="{{ $.Site.Params.github_base_url }}/issues/new?{{ $issueQuery | safeURL }}" target="_blank">Report Issues</a></li>
<li><a href="{{ $.Site.Params.github_url }}/issues/new?{{ $issueQuery | safeURL }}" target="_blank">Report Issues</a></li>
{{ $editQuery := (querify "description" "Signed-off-by: NAME <EMAIL_ADDRESS>\n\n") }}
<li><a href="{{ $.Site.Params.github_base_url }}/edit/main/site/content/{{ with .File }}{{ .Path }}{{ end }}?{{ $editQuery | safeURL }}" target="_blank"><img src="/img/github-blue.svg" /> Edit</a></li>
<li><a href="{{ $.Site.Params.github_url }}/edit/main/site/content/{{ with .File }}{{ .Path }}{{ end }}?{{ $editQuery | safeURL }}" target="_blank"><img src="/img/github-blue.svg" /> Edit</a></li>
{{ end }}
</ul>
{{ if ne .TableOfContents "<nav id=\"TableOfContents\"></nav>" }}
Expand Down

0 comments on commit 1ddb0fb

Please sign in to comment.