Skip to content

Commit 504f7e0

Browse files
authored
Fix outdated documentation: broken links, wrong paths, stale claims (#9087)
- Update Go version requirement from 1.18 to 1.25 to match go.mod - Fix broken links to knative/docs (repo restructured), traces docs, and working groups - Fix incorrect YAML file paths in debugging examples - Update CEL description to reflect its current widespread adoption - Correct OPA/Rego characterization (OPA never replaced Rego with CEL) - Fix CloudEvents spec links from v1.0-rc1 to v1.0.2 - Remove broken link to deleted interfaces.md, fix empty Source link - Fix eventing.kantive.dev typo to eventing.knative.dev - Remove stale TODOs in bug triage doc - Update master branch refs to main - Replace deprecated K8s scheduling policies link - Fix test/e2e README link to config.go
1 parent 96ca1b2 commit 504f7e0

8 files changed

Lines changed: 27 additions & 37 deletions

File tree

DEVELOPMENT.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Before submitting a PR, see also [contribution guidelines](./CONTRIBUTING.md).
3131
You must install these tools:
3232

3333
1. [`go`](https://golang.org/doc/install): The language `Knative Eventing` is
34-
developed with (version 1.18 or higher)
34+
developed with (version 1.25 or higher)
3535
1. [`git`](https://help.github.com/articles/set-up-git/): For source control
3636
1. [`ko`](https://github.com/google/ko): For building and deploying container
3737
images to Kubernetes in a single command.
@@ -160,14 +160,14 @@ kubectl -n knative-eventing logs $(kubectl -n knative-eventing get pods -l app=e
160160
Install the
161161
[In-Memory-Channel](https://github.com/knative/eventing/tree/main/config/channels/in-memory-channel)
162162
since this is the
163-
[default channel](https://github.com/knative/docs/blob/main/docs/eventing/channels/default-channels.md).
163+
[default channel](https://knative.dev/docs/eventing/configuration/channel-configuration/).
164164

165165
```shell
166166
ko apply -Rf config/channels/in-memory-channel/
167167
```
168168

169169
Depending on your needs you might want to install other
170-
[channel implementations](https://github.com/knative/docs/blob/main/docs/eventing/channels/channels-crds.md).
170+
[channel implementations](https://knative.dev/docs/eventing/channels/).
171171

172172
## Install Broker
173173

@@ -284,7 +284,7 @@ To access Telemetry see:
284284

285285
- [Accessing Metrics](https://knative.dev/docs/eventing/observability/metrics/collecting-metrics/)
286286
- [Accessing Logs](https://knative.dev/docs/eventing/observability/logging/collecting-logs/)
287-
- [Accessing Traces](https://www.knative.dev/docs/eventing/accessing-traces/)
287+
- [Accessing Traces](https://knative.dev/docs/eventing/observability/metrics/collecting-metrics/#traces)
288288

289289
## Packet sniffing
290290

@@ -431,11 +431,11 @@ You can debug any component by applying its config with `--debug`:
431431

432432
```shell
433433
# Debug the in-memory channel dispatcher
434-
ko apply -f config/channels/in-memory-channel/300-dispatcher.yaml --debug
434+
ko apply -f config/channels/in-memory-channel/deployments/dispatcher.yaml --debug
435435
kubectl -n knative-eventing port-forward deploy/imc-dispatcher 40000:40000
436436
437437
# Debug the MT broker ingress
438-
ko apply -f config/brokers/mt-channel-broker/500-ingress.yaml --debug
438+
ko apply -f config/brokers/mt-channel-broker/500-broker-ingress.yaml --debug
439439
kubectl -n knative-eventing port-forward deploy/mt-broker-ingress 40000:40000
440440
```
441441

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For complete Knative Eventing documentation, see
5151

5252
If you are interested in contributing, see [the ready to work issues](https://clotributor.dev/search?ts_query_web=knative+eventing&page=1), [CONTRIBUTING.md](./CONTRIBUTING.md),
5353
[DEVELOPMENT.md](./DEVELOPMENT.md) and
54-
[Knative working groups](https://knative.dev/community/contributing/working-groups/working-groups/#eventing).
54+
[Knative working groups](https://github.com/knative/community/blob/main/working-groups/WORKING-GROUPS.md#eventing).
5555

5656
Interested users should join
5757
[knative-users](https://groups.google.com/forum/#!forum/knative-users).

docs/broker/filtering.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -387,17 +387,9 @@ spec:
387387

388388
The main caveat is the choice of CEL as expression language.
389389

390-
CEL is new and the language is not officially supported by Google. Participation
391-
by non-Google contributors is low. OPA is planning to replace their policy
392-
language Rego with CEL, but
393-
[no timeline has been announced for this migration](https://github.com/open-policy-agent/opa/issues/811#issuecomment-401844999).
394-
The KrakenD API Gateway has announced support for CEL
395-
[here](https://medium.com/devops-faith/krakend-api-gateway-0-9-released-9427c249dbcd).
396-
397-
The CEL language is new and has limited exposure, despite being informed by
398-
experience and research at Google. We may discover issues that make it less
399-
suitable for Trigger filtering (e.g.
400-
[google/cel-go#203](https://github.com/google/cel-go/issues/203).
390+
CEL has since become widely adopted across the cloud-native ecosystem, including
391+
Kubernetes (e.g. validation rules, admission policies), Istio, and other
392+
projects. It is officially supported by Google.
401393

402394
If CEL turns out to be a liability, a new expression language could be added
403395
alongside CEL without breaking existing triggers, allowing for an orderly
@@ -496,12 +488,10 @@ been judged less suitable for Trigger filtering than CEL.
496488
already as a policy expression language by
497489
[Open Policy Agent](https://www.openpolicyagent.org/). It could be an attractive
498490
choice, but
499-
[OPA has indicated a desire to replace Rego with CEL](https://github.com/open-policy-agent/opa/issues/811#issuecomment-401844999).
500-
Since Rego doesn't seem to be used outside OPA, choosing Rego for Trigger
501-
filters would likely make Triggers the only remaining use of Rego.
502-
503-
The possible maintenance burden of being the only Rego user makes Rego less
504-
suitable for Trigger filtering than CEL.
491+
OPA has continued to develop Rego as its policy language. Since Rego is
492+
primarily used within the OPA ecosystem, choosing Rego for Trigger filters
493+
would add an additional dependency without broad ecosystem benefits, making
494+
Rego less suitable for Trigger filtering than CEL.
505495

506496
#### Custom expression language
507497

docs/mt-channel-based-broker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The `mt-broker-controller` is kind of the heart of the MTChannelBasedBroker cont
3333
name: config-br-default-channel
3434
namespace: knative-eventing
3535
```
36-
* Updates the status on `Broker` resources with the `eventing.kantive.dev/broker.class: MTChannelBasedBroker` annotation with the address for the broker ingress.
36+
* Updates the status on `Broker` resources with the `eventing.knative.dev/broker.class: MTChannelBasedBroker` annotation with the address for the broker ingress.
3737

3838
### Channel specific controllers (e.g. `imc-controller`)
3939

docs/planning/bug_triage.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ process.
4242

4343
## Bug Triage
4444

45-
- WG lead will form a bug triage team (TODO: Ville)
45+
- WG lead will form a bug triage team.
4646
- There will be one bug triage champion each week to triage incoming bugs and
4747
assign them correct priority. This role will be rotated among engineers in the
4848
bug triage team.
@@ -59,8 +59,9 @@ process.
5959
we should close the bug upon triaging. [Remember the goal](#Goal).
6060
- Bugs with priority/critical-urgent and priority/important-soon bugs should
6161
have an assigned owner who has acknowledged the ownership of the bug.
62-
- TODO: Update these guidelines based on learning from triage meetings. Triage
63-
team will own and update this document and WG lead will approve the changes.
62+
- These guidelines should be updated based on learnings from triage meetings.
63+
Triage team will own and update this document and WG lead will approve the
64+
changes.
6465
- In case of conflict, final decision will be taken by WG lead.
6566
- WG lead will periodically monitor bug count and trend to make sure we meet our
6667
[goal](#Goal).

docs/spec/sources.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ relays that event to another endpoint on the cluster via
55
[CloudEvents](https://cloudevents.io). Sourcing events is critical to developing
66
a distributed system that reacts to events.
77

8-
A **Sink** is an [_addressable_](./interfaces.md#addressable) resource that
8+
A **Sink** is an _addressable_ resource that
99
takes responsibility for the event. A **Sink** could be a consumer of events, or
1010
middleware. A **Sink** will respond with 2xx when it has accepted and processed
1111
the event.
@@ -42,7 +42,7 @@ For operators of a Kubernetes cluster, there are two states to sources:
4242
for that source for the current situation. While this resource is running, a
4343
cluster operator would like to inspect the resource without needing to be
4444
fully aware of the implementation. This is done by conforming to the
45-
[Source]() ducktype. This topic is expanded upon in the
45+
Source ducktype. This topic is expanded upon in the
4646
[Source Custom Objects](#source-custom-objects) section.
4747

4848
The goal of requiring CRD labels and running resource shapes is to enable
@@ -230,10 +230,10 @@ unmarshalled by tooling (e.g., a CLI). In particular, each object in the array
230230
MUST contain the following fields:
231231
232232
- type: String. Refers to the
233-
[CloudEvents type](https://github.com/cloudevents/spec/blob/v1.0-rc1/spec.md#type)
233+
[CloudEvents type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type)
234234
attribute. Mandatory.
235235
- schema: String. Refers to the
236-
[CloudEvents dataschema](https://github.com/cloudevents/spec/blob/v1.0-rc1/spec.md#dataschema)
236+
[CloudEvents dataschema](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#dataschema)
237237
attribute. Optional.
238238
- description: String describing the event. Optional.
239239

pkg/scheduler/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,9 @@ changes.)
8787

8888
* https://kubernetes.io/docs/concepts/scheduling-eviction/scheduling-framework/
8989
* https://github.com/kubernetes-sigs/descheduler
90-
* https://kubernetes.io/docs/reference/scheduling/policies/
91-
* https://kubernetes.io/docs/reference/config-api/kube-scheduler-policy-config.v1
90+
* https://kubernetes.io/docs/reference/config-api/kube-scheduler-config.v1/
9291
* https://github.com/virtual-kubelet/virtual-kubelet#how-it-works
93-
* https://github.com/kubernetes/enhancements/tree/master/keps/sig-scheduling/624-scheduling-framework
92+
* https://github.com/kubernetes/enhancements/tree/main/keps/sig-scheduling/624-scheduling-framework
9493
* https://medium.com/tailwinds-navigator/kubernetes-tip-how-statefulsets-behave-differently-than-deployments-when-node-fails-d29e36bca7d5
9594
* https://kubernetes.io/docs/concepts/architecture/nodes/#node-controller
9695

@@ -100,4 +99,4 @@ To learn more about Knative, please visit the
10099
[/docs](https://github.com/knative/docs) repository.
101100

102101
This repo falls under the
103-
[Knative Code of Conduct](https://github.com/knative/community/blob/master/CODE-OF-CONDUCT.md)
102+
[Knative Code of Conduct](https://github.com/knative/community/blob/main/CODE-OF-CONDUCT.md)

test/e2e/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Knative Eventing e2e tests
99
to verify the behavior of this specific implementation.
1010

1111
If you want to add tests for a new `channel` and reuse existing tests for it,
12-
please look into [config.go](../common/config.go) and make corresponding
12+
please look into [config.go](../lib/config.go) and make corresponding
1313
changes.
1414

1515
If you want to add a new test case, please add one new test file under [e2e](.)

0 commit comments

Comments
 (0)