[docs] Fixing some broken links #778
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jasonmadigan The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
links work |
| @@ -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). | |||
There was a problem hiding this comment.
@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?
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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)
Ref: Kuadrant/docs.kuadrant.io#56