Skip to content

Replace self-referenced links with relative paths #167

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.

Sign up for GitHub

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

Open
ali-a-a wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

Replace self-referenced links with relative paths #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ spec:
node-role.kubernetes.io/worker: ""
```
Find a more detailed walkthrough of setting up Node Readiness Controller in your Kind cluster [here](https://github.com/kubernetes-sigs/node-readiness-controller/blob/main/docs/TEST_README.md).
Find a more detailed walkthrough of setting up Node Readiness Controller in your Kind cluster [here](docs/TEST_README.md).
## High-level Roadmap
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/examples/cni-readiness.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The high-level steps are:

This example uses **Calico**, but the pattern applies to any CNI.

> **Note**: You can find all the manifests used in this guide in the [`examples/cni-readiness`](https://github.com/kubernetes-sigs/node-readiness-controller/tree/main/examples/cni-readiness) directory.
> **Note**: You can find all the manifests used in this guide in the [`examples/cni-readiness`](../../../../examples/cni-readiness) directory.
Copy link
Contributor

@ajaysundark ajaysundark Mar 15, 2026

Choose a reason for hiding this comment

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

I dont think this works as how you expect it to be. AFAICT, the netlify will know only the 'docs/book/src' universe, so any parent directory ('../') look up above will still refer to the root, so this will eventually self-reference this page than the code-directory (examples/cni-readiness) you're looking to link here.

you can check the deploy preview here: https://deploy-preview-167--node-readiness-controller.netlify.app/ (you can find this at the PR).

I think the goal of this PR could be to only replace relative-links for "doc pages" not the code-references.

### 1. Deploy the Readiness Condition Reporter

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/examples/constrained-impersonation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This guide walks through a CNI readiness example that uses constrained impersona

> **Prerequisites**: Kubernetes v1.35+ with the `ConstrainedImpersonation` feature gate enabled, or v1.36+ where it is Beta and enabled by default.

> **Note**: You can find all the manifests used in this guide in the [`examples/constrained-impersonation`](https://github.com/kubernetes-sigs/node-readiness-controller/tree/main/examples/constrained-impersonation) directory.
> **Note**: You can find all the manifests used in this guide in the [`examples/constrained-impersonation`](../../../../examples/constrained-impersonation) directory.

## Step-by-Step Guide

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/examples/security-agent-readiness.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ We can use the Node Readiness Controller to enforce a security readiness guardra

This example uses **Falco** as a representative security agent, but the same pattern applies to any node-level security or monitoring agent.

> **Note**: All manifests referenced in this guide are available in the [`examples/security-agent-readiness`](https://github.com/kubernetes-sigs/node-readiness-controller/tree/main/examples/security-agent-readiness) directory.
> **Note**: All manifests referenced in this guide are available in the [`examples/security-agent-readiness`](../../../../examples/security-agent-readiness) directory.



Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/user-guide/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ kubectl apply -k config/crd
kubectl apply -k config/default
```

You can enable optional components (Metrics, TLS, Webhook) by creating a `kustomization.yaml` that includes the relevant components from the `config/` directory. For reference on how these components can be combined, see the `deploy-with-metrics`, `deploy-with-tls`, `deploy-with-webhook`, and `deploy-full` targets in the projects [`Makefile`](https://github.com/kubernetes-sigs/node-readiness-controller/blob/main/Makefile).
You can enable optional components (Metrics, TLS, Webhook) by creating a `kustomization.yaml` that includes the relevant components from the `config/` directory. For reference on how these components can be combined, see the `deploy-with-metrics`, `deploy-with-tls`, `deploy-with-webhook`, and `deploy-full` targets in the projects [`Makefile`](../../../../Makefile).

---

Expand Down
Loading