Skip to content

Commit c05e96c

Browse files
committed
Fix external links, add github action
1 parent 7bddbcc commit c05e96c

File tree

5 files changed

+27
-7
lines changed

5 files changed

+27
-7
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Verify docs broken links
2+
3+
on:
4+
pull_request:
5+
types: [opened, edited, synchronize, reopened]
6+
7+
# Remove all permissions from GITHUB_TOKEN except metadata.
8+
permissions: {}
9+
10+
jobs:
11+
verify-docs:
12+
name: Build website and run lychee
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # tag=v6.0.1
17+
with:
18+
persist-credentials: false
19+
- name: Run validation
20+
run: |
21+
make verify-docs

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ build-docs: update-geps api-ref-docs
201201

202202
.PHONY: verify-docs
203203
verify-docs: build-docs
204-
docker run -it --rm -w /input -v ${PWD}:/input $(DOCS_VERIFY_CONTAINER_IMAGE) --root-dir /input/site --exclude-path "overrides/partials/.*\.html" --exclude ".*" --include "k8s.io" --include "kubernetes.io" --include "github.com" /input/site/**/*.html
204+
docker run -it --rm -w /input -v ${PWD}:/input $(DOCS_VERIFY_CONTAINER_IMAGE) --root-dir /input/site --exclude-path "overrides/partials/.*\.html" --exclude ".*" --include "k8s.io" --include "kubernetes.io" --include "github.com/kubernetes" /input/site/**/*.html
205205

206206
.PHONY: build-docs-netlify
207207
build-docs-netlify: update-geps api-ref-docs

geps/gep-2162/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This GEP proposes to enhance the [GatewayClassStatus](https://github.com/kuberne
2828

2929
The current [GatewayClassStatus](https://github.com/kubernetes-sigs/gateway-api/blob/f2cd9bb92b4ff392416c40d6148ff7f76b30e649/apis/v1beta1/gatewayclass_types.go#L185) is only used to store conditions the controller publishes.
3030

31-
Partnered with the [Conformance Profiles](https://github.com/kubernetes-sigs/gateway-api/blob/main/geps/gep-1709.md) work, we want to:
31+
Partnered with the [Conformance Profiles](/geps/gep-1709/) work, we want to:
3232

3333
1. Improve UX by enabling users to easily see what features the implementation(GatewayClass) support.
3434
1. Standardize features and conformance tests names.
@@ -162,15 +162,15 @@ Before we make the changes we need to;
162162

163163
### Re-using ConformanceProfiles structs
164164

165-
We could use the same structs as we do in conformance profile object, more specifically, the [ProfileReport](https://github.com/kubernetes-sigs/gateway-api/blob/main/conformance/apis/v1alpha1/profilereport.go#LL24C6-L24C19) struct.
165+
We could use the same structs as we do in conformance profile object, more specifically, the [ProfileReport](https://github.com/kubernetes-sigs/gateway-api/blob/main/conformance/apis/v1/conformancereport.go#LL28C6-L28C19) struct.
166166

167167
Though it would be nice to have only one place to update, these structs seems to include much more data relevant to the conformance report but not for our use case.
168168

169169
That said, conformance profiles are still at experimental stage, we could explore the option to create a shared struct that will be used both for the conformance reports and for the GatewayClass status.
170170

171171
### Instruct users to read from the future conformance profiles report
172172

173-
The current plan for conformance profiles is to also include centralized reporting. (more info in [gep-1709](https://github.com/kubernetes-sigs/gateway-api/blob/main/geps/gep-1709.md))
173+
The current plan for conformance profiles is to also include centralized reporting. (more info in [gep-1709](/geps/gep-1709/))
174174
We could wait for this to be implemented and instruct users to read from that source to determine what features their installed GatewayClass support.
175175

176176
However, having the supported features published in the GatewayClass Status adds the following values:

hack/mkdocs/generate.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ for i in "${arr[@]}"; do
4343
tmpdir=$(mktemp -d --tmpdir=${PWD}/tmp)
4444

4545
git fetch ${REMOTE} ${i} ||
46-
echo "You need a git remote pointing to upstream for API Ref generation.";
47-
echo "To solve this issue locally, execute 'git remote add upstream [email protected]:kubernetes-sigs/gateway-api.git' and then call the script again with 'REMOTE=upstream <command>'"
46+
echo "You need a git remote pointing to upstream for API Ref generation. To solve this issue locally, execute 'git remote add upstream [email protected]:kubernetes-sigs/gateway-api.git' and then call the script again with 'REMOTE=upstream <command>'"
4847
git --work-tree=${tmpdir} checkout ${REMOTE}/${i} -- apis apisx
4948

5049
# Start removing any "release-" prefix from docpath

site-src/blog/2022/graduating-to-beta.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ If there's something on this list you want to get involved in, or there's
175175
something not on this list that you want to advocate be on the roadmap
176176
please join us in the #sig-network-gateway-api channel on Kubernetes Slack or our weekly [community calls](../../contributing/index.md#meetings).
177177

178-
[gep1016]:https://github.com/kubernetes-sigs/gateway-api/blob/master/geps/gep-1016.md
178+
[gep1016]:/geps/gep-1016/
179179
[grpc]:https://grpc.io/
180180
[pr1085]:https://github.com/kubernetes-sigs/gateway-api/pull/1085
181181
[tcpr]:https://github.com/kubernetes-sigs/gateway-api/blob/main/apis/v1alpha2/tcproute_types.go

0 commit comments

Comments
 (0)