Aiven-Open / Aiven-Open/klaw-docs

Check link checking problem

Open
#167 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
4
Forks
10
PR merge metrics
No merged PRs in 30d

Description

# Description

- after update to Docusaurus 3, some link checks fail when running `npm run start` for valid and working links to `.md` files. It's always file where the path is e.g. `../../docs`. The link do work, so we may be able to set the broken link check to `warn`. It's recommended to use `.md` links when possible.

BUT
- the markdown-link-check job in the pipeline currently does not fail the job when it's having an error. This needs to be fixed before changing the `error` to `warn`

## Todo
- get link check pipeline to fail when it should
- check why brokenLinkCheck for docusaurus fails, if needed set to warn instead of error

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.