Skip to content
This repository has been archived by the owner on Jul 8, 2023. It is now read-only.

Several Documentation links not found (404) #308

Closed
2 tasks done
nicogenz opened this issue Dec 14, 2021 · 10 comments
Closed
2 tasks done

Several Documentation links not found (404) #308

nicogenz opened this issue Dec 14, 2021 · 10 comments

Comments

@nicogenz
Copy link

Prerequisites

  • I have written a descriptive issue title
  • I have searched existing issues to ensure the bug has not already been reported

Fastify version

3.25.0

Plugin version

No response

Node.js version

16

Operating system

Linux

Operating system version (i.e. 20.04, 11.3, 10)

20.04

Description

Some Documentation links are currently pointing into nowhere (404). This is probably related to the following PR where the documentation has been reworked, fastify/fastify#3474, which has been released with version 3.25.0.
For example the link for the "Recommendations" in the README.md is still pointing to https://github.com/fastify/fastify/blob/main/docs/Recommendations.md however it should point to https://github.com/fastify/fastify/blob/main/docs/Guides/Recommendations.md.
The same appears on the website. If you search for "Recommendations" it navigates you to the wrong url:
image

Steps to Reproduce

  • Search for Recommandations in the search field on the website
    or
  • Click the Recommendations link in the README.md

Expected Behavior

It should navigate to the new docs location.

@jsumners jsumners transferred this issue from fastify/fastify Dec 14, 2021
@luisorbaiceta
Copy link
Member

luisorbaiceta commented Dec 14, 2021

This is probably related to the index of Algolia. We need to update it. Someone with access should check @mcollina @jsumners
This link is working from the toc.

@jsumners
Copy link
Member

I don't think I have access to that.

@luisorbaiceta
Copy link
Member

cc @lmammino

@mcollina
Copy link
Member

I think we should update https://github.com/algolia/docsearch-configs/blob/master/configs/fastify.json. I'm going to open an issue there and see. Maybe @luisorbaiceta you can take a look as well! Thanks

@jsumners
Copy link
Member

I think we should update algolia/docsearch-configs@master/configs/fastify.json. I'm going to open an issue there and see. Maybe @luisorbaiceta you can take a look as well! Thanks

😨 our docs rely on updating a config in a completely different org managed by a completely different team?

@luisorbaiceta
Copy link
Member

If It's ok I will temporarily hide the search bar until this is solved.

😨 our docs rely on updating a config in a completely different org managed by a completely different team?

I agree we need a way to update the index or config via github actions in our ci

@nicogenz
Copy link
Author

This is not only an issue on the website. Some links on the README.md of the Fastify repo are also pointing to the wrong direction. See https://github.com/fastify/fastify/blob/main/README.md#documentation. For example the Hooks, Decorators, Lifecycle....
If you want I can open a PR and fix this.

@mcollina
Copy link
Member

If you want I can open a PR and fix this.

Go aghead!

@nicogenz
Copy link
Author

Opened a PR for the README.md issue: fastify/fastify#3539

@mcollina
Copy link
Member

I fixed it

@mcollina mcollina mentioned this issue Dec 14, 2021
2 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants