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

docs: use QGB permalinks to appease markdown link check #2750

Merged
merged 2 commits into from
Nov 6, 2023

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Oct 23, 2023

Closes #2749

Note: we've discussed avoiding backporting docs changes so we can close this PR if we're okay with markdown link check failing on the v1.x branch from now on.

Testing

On the v1.x branch, locally make markdown-link-check passes

@rootulp rootulp added the documentation Improvements or additions to documentation label Oct 23, 2023
@rootulp rootulp requested review from cmwaters and staheri14 October 23, 2023 16:12
@rootulp rootulp self-assigned this Oct 23, 2023
@rootulp rootulp marked this pull request as ready for review October 29, 2023 12:31
@rootulp rootulp enabled auto-merge (squash) October 29, 2023 12:31
@codecov-commenter
Copy link

codecov-commenter commented Oct 29, 2023

Codecov Report

Merging #2750 (42f8503) into v1.x (ada7750) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             v1.x    #2750   +/-   ##
=======================================
  Coverage   20.20%   20.20%           
=======================================
  Files         139      139           
  Lines       16237    16237           
=======================================
  Hits         3280     3280           
  Misses      12649    12649           
  Partials      308      308           

Copy link
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for handling this. I think it would be better to use x/blobstream in the link and keep main branch instead of referring to old docs before the rename.

@rootulp
Copy link
Collaborator Author

rootulp commented Nov 1, 2023

I think links to docs should use permalinks so that we don't break the links again due to a future rename or docs move. Also I think it's a bit confusing that the v1.x branch contains references to "qgb" and then links to "blobstream" docs. If we do that, the docs should clarify the name change.

@rach-id
Copy link
Member

rach-id commented Nov 1, 2023

True, we're planning to write a small ADR around renaming so that it's more clear

@rootulp
Copy link
Collaborator Author

rootulp commented Nov 6, 2023

IDK what to do for this PR but I don't think we should remain content with CI ❌ s on all future PRs to the v1.x branch. Three options I can see to get this moving forward (in order of preference from most preferred to least):

  1. Remove the broken code links entirely
  2. Replace the broken code links with permalinks to v1.x code
  3. Replace the broken code links with permalinks to the same code on main. IMO confusing b/c the rename from QGB -> Blobstream which wasn't fully backported to v1.x

Ultimately I defer to you @sweexordious b/c you're the primary owner on QGB docs

@rootulp rootulp requested a review from rach-id November 6, 2023 14:05
@rootulp rootulp merged commit 9cae513 into celestiaorg:v1.x Nov 6, 2023
21 checks passed
@rootulp rootulp deleted the rp/fix-qgb-links branch November 6, 2023 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants