airbytehq/airbyte

Fix broken links in docs.airbyte.io

Open

#33874 opened on Jan 3, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (12,832 stars) (3,358 forks)batch import
area/documentationautoteamgood first issuehelp-welcometeam/documentation

Description

Topic

We use Docusaurus to build https://docs.airbyte.io — it builds a documenatation website from docs that we have in ./docs in this repo.

At build time, Docusaurus will check that all internal relative links are correct. But it does not check absolute or extenral links. We have another GitHub Action that checks them: https://github.com/airbytehq/airbyte/blob/master/.github/workflows/doc-link-check.yml — and there are quite a few broken links.

Would be good to get this check back to green.

If you want to contribute all / some of fixes, I would be happy to review them. Sometimes links break just because a page moved, and sometimes it's external vendor documentation, so you have to be careful choosing a new URL.

There are quite a few broken links, so I won't assign this particular issue, but feel free to put together a PR cleaning them up and assign me to be a reviewer. You can find an up to date list of broken links here:

https://github.com/airbytehq/airbyte/actions/workflows/doc-link-check.yml

Contributor guide

Tech stack
javascripttypescriptreact
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with markdownAbility to verify external links
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Check the link check action output at https://github.com/airbytehq/airbyte/actions/workflows/doc link check.yml for a list of broken links. For each broken link, find the correct replacement URL by searching the documentation or vendor sites. Replace the broken links in the .md files under ./docs. Submit a PR with fixes, ensuring internal links remain correct.