Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Broken link to 'building new connectors' in docs #14320

Closed
grishick opened this issue Jun 30, 2022 · 2 comments · Fixed by #16504
Closed

Broken link to 'building new connectors' in docs #14320

grishick opened this issue Jun 30, 2022 · 2 comments · Fixed by #16504
Labels
area/documentation Improvements or additions to documentation autoteam team/documentation type/bug Something isn't working

Comments

@grishick
Copy link
Contributor

Tell us about the documentation you'd like us to add or update.

On this page https://docs.airbyte.com/integrations/contributing-to-airbyte/ , this link building new connectors is broken. Clicking it results in a 404 error.

If applicable, add links to the relevant docs that should be updated

@grishick grishick added area/documentation Improvements or additions to documentation type/enhancement New feature or request type/bug Something isn't working and removed type/enhancement New feature or request labels Jun 30, 2022
@grishick grishick changed the title Broken link in docs Broken link to 'building new connectors' in docs Jun 30, 2022
@jromero
Copy link

jromero commented Jul 8, 2022

FWIW, this seems related to this issue: facebook/docusaurus#2654 (comment)

If you navigate through the menu to https://docs.airbyte.com/integrations/custom-connectors you end up with no trailing space and "contributing guide on building connectors".

If you navigate to the same page via URL (ie type it into browser), a trailing slash is automatically added: https://docs.airbyte.com/integrations/custom-connectors/ and the same link is now broken "contributing guide on building connectors" because "../contributing-to-airbyte" is now using a different relative directory.

@jromero
Copy link

jromero commented Jul 8, 2022

I spent a little more time on this out of curiosity and I have to say, there doesn't seem to be a quick satisfactory fix for this due to my understanding that the docs use GitHub Pages. GitHub Pages is what creates the redirect for directories from custom-connectors -> custom-connectors/ (see behavior documented here).

Adding trailingSlashes: true option to docusaurus does resolve the issue in that the behavior is predictable between navigation and browser input but the links within markdown because awkwardly misleading. For example, in markdown, [contributing guide on building connectors](../contributing-to-airbyte/) would actually need to be [contributing guide on building connectors](../../contributing-to-airbyte/) which isn't accurate in the local filesystem given:

docs
│
├── contributing-to-airbyte
│   ├── README.md
│   └── ...
├── integrations
│   ├── README.md
│   ├── custom-connectors.md # <-- LINK HERE
│   └── ...
└── ...

There may be other options I haven't found or considered. I'd be interested to hear what the maintainers think would be the best possible path forward given the constraints.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation autoteam team/documentation type/bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants