Can't get a redirect to pass CI checks from the Kibana repo

[florent-leborgne]

Describe the bug

In elastic/kibana#234425, I'm trying to redirect a file with outdated instruction to a different file that was published in another doc set and that has up to date information. To do this I:

• Removed the outdated file from the TOC and deleted the file
• Created a redirects.yml file next to that repo's docset.yml file, that is inside of this repo's /docs folder.

I haven't yet cleaned up links to the removed file as I wanted to test that the redirection is correctly working before.

What happens is that I cannot get the CI checks to pass, so I'm unable to test the redirection.
I tried paths with and without "docs/" as I thought this was maybe due to the fact that the docset.yml file isn't at the root of the repo:

• Without docs/, so starting from extend/, the redirect validation fails.
• With docs/, the redirect validation passes but the build fails saying that the file I'm trying to redirect to doesn't exist because of links in other files, hinting that these links are actually not being redirected.

This leads me to think that there is either a gap in the guidance and I haven't followed proper instructions, or that there's still a gap in the implementation of the redirection system.

Expected behavior

I would expect the CI to pass and that remaining links are properly redirected. Remaining links that could be cleaned up but that are redirected could be flagged as a warning though, that would be useful, without being blocking.

Steps to reproduce

No response

Tooling

• docs-builder
• migration tooling
• I'm not sure

[Mpdreamz]

Regarding having to prefix the keys with docs/ this is a bug on our end when calling docs-builder diff validate.

#1866 Addresses that.

---

As for the fact that it complains is that we currently expect you to rewrite the local links as part of the same PR for good hygiene.

Testing the redirect is part of docs-builder diff validate, it will complain when you cross-link to something that does not exists.

I personally don't think we should add support for silently rewriting local links in sources. like we do cross-links.

[Mpdreamz]

Discussed this with @florent-leborgne docs-builder will need to emit a better error message if the local link links to a deleted file but one that is redirect.yml to update it to the file it links to instead.