airbytehq / airbyte

The leading data integration platform for ETL / ELT data pipelines from APIs, databases & files to data warehouses, data lakes & data lakehouses. Both self-hosted and Cloud-hosted.
https://airbyte.com
Other
15.4k stars 3.97k forks source link

Fix broken links in docs.airbyte.io #33874

Open natikgadzhi opened 8 months ago

natikgadzhi commented 8 months ago

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

sridharsabarish commented 8 months ago

Hello,

I went through the actions/workflows and found some errors, i believe these are the ones that needs to be fixed. Can you please describe where can i search for updated external links and any specific location in the code where these needs to be updated. This is my very first time with open source.

natikgadzhi commented 8 months ago

@sabarish-sridhar, well, that's the tricky part. There's no easy spot to just find all the links that we need to put in place for the old ones, you'd need to figure that out from the context, and find relevant material to link to. And that will not always be obvious.

In general, you should probably only attempt fixing areas that are already known to you from past experience with a certain vendor.