Skip to content
This repository has been archived by the owner on Dec 16, 2024. It is now read-only.

[docs] Fixing some broken links #778

Merged
merged 1 commit into from
Jan 30, 2024
Merged

[docs] Fixing some broken links #778

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ When deploying the multicluster gateway controller using the make targets, the f
* go >= 1.21

### 1. Running the controller in the cluster:
1. Set up your DNS Provider by following these [steps](providers/providers.md)
1. Set up your DNS Provider by following these [steps](./docs/dnspolicy/dns-provider.md)

1. Setup your local environment
```sh
Expand Down Expand Up @@ -63,7 +63,7 @@ When deploying the multicluster gateway controller using the make targets, the f
```

## 2. Running the controller locally:
1. Set up your DNS Provider by following these [steps](providers/providers.md)
1. Set up your DNS Provider by following these [steps](./docs/dnspolicy/dns-provider.md)

1. Setup your local environment

Expand Down
4 changes: 2 additions & 2 deletions docs/managed-zone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ EOF
#### dnsProviderSecretRef

This is a reference to secret containing the credentials and other configuration for accessing your dns provider
[dnsProvider](/docs/dnspolicy/dns-provider.md)
[dnsProvider](./dnspolicy/dns-provider.md)

**Note:** the Secret referenced in the `dnsProviderSecretRef` field must be in the same namespace as the ManagedZone.

Expand All @@ -83,5 +83,5 @@ At the moment the MGC is given credentials to connect to the DNS provider at sta
There are plans to make this more customizable and dynamic in the future, [work tracked here](https://github.com/Kuadrant/multicluster-gateway-controller/issues/228).

## Spec of a ManagedZone
The ManagedZone is a simple resource with an uncomplicated API, see a sample [here](../config/samples/kuadrant.io_v1alpha1_managedzone.yaml).
The ManagedZone is a simple resource with an uncomplicated API, see a sample [here](https://github.com/Kuadrant/multicluster-gateway-controller/blob/main/config/samples/kuadrant.io_v1alpha1_managedzone.yaml).
Copy link
Member

Choose a reason for hiding this comment

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

@jasonmadigan Does this have to reference main?

Not that important in this particular case as this whole doc will likely be removed soon, but would it not be preferable for docs to use relative paths?

Copy link
Member Author

Choose a reason for hiding this comment

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

@mikenairn yeah, other option is: we add the config path to the import paths for mkdocs, which will hover these resources up into the bundle. Download links will then download the file as is, from the branch you've selected from the import URL. That may be preferable as we seem to be heading towards versioning our docs in tandem with component releases.

Copy link
Member

Choose a reason for hiding this comment

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

Right i see, we would need to update this i guess to include all relatively linked files here? https://github.com/Kuadrant/docs.kuadrant.io/blob/main/mkdocs.yml#L52

Bit annoying maybe, but probably better option long term. If we have the PR builds check with mkdocs build -s we should at least be able to catch and fix them as we update versions before we hit main of docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

Exactly yes

Thinking on it more, I think that might be our best route. The associated docs PR for this will build mkdocs with the -s switch (when these broken link PRs land)