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

Change Airbyte Spec doc links to permalinks. #7019

Merged
merged 1 commit into from
Oct 19, 2021
Merged

Conversation

avaidyanatha
Copy link
Contributor

Main Changes

  • A lot of line references are out of sync since we didn't use permalinks, this switches all old links to reference the correct lines and makes them use permalinks.

@avaidyanatha avaidyanatha added the area/documentation Improvements or additions to documentation label Oct 13, 2021
@avaidyanatha avaidyanatha temporarily deployed to more-secrets October 13, 2021 20:02 Inactive
@michel-tricot
Copy link
Contributor

does it mean we need to update the blob id everytime we change these files to ensure we have the latest version?

@cgardens
Copy link
Contributor

does it mean we need to update the blob id everytime we change these files to ensure we have the latest version?

We have to update these links every time we make changes regardless of this change. The problem we are trying to solve is we have links that refer to line numbers but then over time the line numbers drift as the files change but the links aren't updated. So you pretty much have no guarantee that any of these links are ever right.

The new approach is to at least give a high guarantee that, for eternity, my link will always go to the right place. If I update the underlying doc though I do need to update the link if i want to see the new content.

@avaidyanatha avaidyanatha merged commit 3530429 into master Oct 19, 2021
@avaidyanatha avaidyanatha deleted the abhi/l-inked branch October 19, 2021 18:36
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants