external-dns icon indicating copy to clipboard operation
external-dns copied to clipboard

Published 20 hours ago • verified publisher icon kubernetes-sigs

docs: upgrade mkdocs and fix broken links

Open mloiseleur opened this issue 1 year ago • 3 comments

Description

It upgrades the whole stack.

Checklist

  • [ ] Unit tests updated
  • [x] End user documentation updated

Additional notes

mkdocs serve is clean, except a Warning on /version.json:

WARNING -  [14:24:16] "GET /versions.json HTTP/1.1" code 404

Hopefully, it will be served by mike, but I haven't found how to launch successfully mike on a local branch.

mloiseleur avatar Apr 10 '24 12:04 mloiseleur

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please ask for approval from mloiseleur. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot avatar Apr 10 '24 12:04 k8s-ci-robot

@szuecs Thanks for your review.

For your other comments, the problem is the way it works currently. The README.md is used as front page doc on https://github.com/kubernetes-sigs/external-dns It's also copied in docs/ before generating the mkdocs website.

That makes relative links broken. So I see two solutions:

  1. Split this README into two : one in / and the other in docs/ of this repo
  2. Try to generate the mkdocs without moving the README.md in docs/

Wdyt of those options ? any other idea ?

mloiseleur avatar Apr 28 '24 11:04 mloiseleur

@mloiseleur the second option maybe? I'm not sure aware of the consequences, but duplicating the README is not super great. If we can have an alternative document that doesn't require us to update things in two places every time, then I'm also fine with 1.

Raffo avatar May 11 '24 17:05 Raffo

@Raffo @szuecs mkdocs does not support to use README.md at the root level, see this upstream issue. Nevertheless, there is a plugin that workaround this. The plugin seems to work, so I give it a go.

mloiseleur avatar Jun 03 '24 07:06 mloiseleur

Thanks! Ping me for a review anytime.

Raffo avatar Jun 03 '24 07:06 Raffo

from my side lgtm

szuecs avatar Jun 06 '24 09:06 szuecs

@Raffo @szuecs PR has been rebased. I also added a link to doc website.

mloiseleur avatar Jun 07 '24 06:06 mloiseleur

/lgtm /approve

Raffo avatar Jun 11 '24 07:06 Raffo

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Raffo

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 /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot avatar Jun 11 '24 07:06 k8s-ci-robot