Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): adjust link to the mutation docs #2445

Merged
merged 2 commits into from
Dec 14, 2022
Merged

fix(docs): adjust link to the mutation docs #2445

merged 2 commits into from
Dec 14, 2022

Conversation

tolleiv
Copy link
Contributor

@tolleiv tolleiv commented Dec 9, 2022

Signed-off-by: Tolleiv Nietsch github@tolleiv.de

What this PR does / why we need it:

This is just a small fix in the README. The current link to the mutations is broken - better point to the website directly.

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #

Special notes for your reviewer:

Current link is broken - better point to the website directly.

Signed-off-by: Tolleiv Nietsch <github@tolleiv.de>
Copy link
Contributor

@acpana acpana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this and opening a PR!

LGTM!

@@ -7,7 +7,7 @@ Compared to using [OPA with its sidecar kube-mgmt](https://www.openpolicyagent.o
* An extensible, parameterized [policy library](https://open-policy-agent.github.io/gatekeeper-library/website/)
* Native Kubernetes CRDs for instantiating the policy library (aka "constraints")
* Native Kubernetes CRDs for extending the policy library (aka "constraint templates")
* Native Kubernetes CRDs for [mutation](mutation.md) support
* Native Kubernetes CRDs for [mutation](https://open-policy-agent.github.io/gatekeeper/website/docs/mutation/) support
Copy link
Member

@sozercan sozercan Dec 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the pr! this intentionally refers to mutation.md, as it is meant to direct to the versioned copy of the mutation page. Linking directly like this will break the versioned redirect.

This link works for me, is it broken for you?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am getting this while opening mutation.md from the master. Is the file moved to some other location?

image

Copy link
Member

@sozercan sozercan Dec 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah my bad, I thought this was the docs website link, not readme

Copy link
Member

@sozercan sozercan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sozercan sozercan merged commit 820a892 into open-policy-agent:master Dec 14, 2022
@tolleiv tolleiv deleted the patch-1 branch December 15, 2022 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants