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.

Sign up for GitHub

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

Jump to bottom

Broken Links Detected #5697

Closed
github-actions bot opened this issue Jul 1, 2023 · 9 comments
Closed

Broken Links Detected #5697

github-actions bot opened this issue Jul 1, 2023 · 9 comments
Labels
automated issue Good first issue Help wanted report

Comments

@github-actions
Copy link
Contributor

github-actions bot commented Jul 1, 2023

Summary

Status Count
🔍 Total 686
✅ Successful 618
⏳ Timeouts 1
🔀 Redirected 0
👻 Excluded 19
❓ Unknown 0
🚫 Errors 48

Errors per input

Errors in networks/osmosis-1/upgrades/v7/guide.md

Errors in networks/osmosis-1/upgrades/v11/testnet/guide.md

Errors in networks/osmosis-1/upgrades/v13/testnet/guide.md

Errors in x/concentrated-liquidity/README.md

  • [ERR] file:///home/runner/work/osmosis/osmosis/x/concentrated-liquidity/img/SpreadRewardGrowthOutsideCalcuations.png | Failed: Cannot find file

Errors in x/superfluid/README.md

  • [ERR] file:///home/runner/work/osmosis/osmosis/x/superfluid/07_proposals.md | Failed: Cannot find file
  • [ERR] file:///home/runner/work/osmosis/osmosis/x/superfluid/06_hooks.md | Failed: Cannot find file
  • [ERR] file:///home/runner/work/osmosis/osmosis/x/superfluid/04_epoch.md | Failed: Cannot find file
  • [ERR] file:///home/runner/work/osmosis/osmosis/x/superfluid/03_messages.md | Failed: Cannot find file

Errors in client/docs/static/openapi/index.html

Errors in networks/osmosis-1/upgrades/v15/mainnet/guide.md

Errors in networks/osmosis-1/upgrades/v13/mainnet/guide.md

Errors in x/gamm/client/docs/create-lbp-pool.md

Errors in networks/osmosis-1/upgrades/v14/mainnet/guide.md

Errors in CONTRIBUTING.md

Errors in networks/osmosis-1/upgrades/v12/mainnet/guide.md

Errors in networks/osmosis-1/upgrades/v5/guide.md

Errors in networks/genesis-validators.md

Errors in CHANGELOG.md

Errors in x/gamm/client/docs/README.md

  • [ERR] file:///home/runner/work/osmosis/osmosis/x/gamm/client/docs/create-pool.md | Failed: Cannot find file

Errors in x/gamm/README.md

  • [ERR] file:///home/runner/work/osmosis/osmosis/x/gamm/client/docs/create-pool.md | Failed: Cannot find file

Errors in networks/osmosis-1/upgrades/v11/mainnet/guide.md

Errors in networks/osmosis-1/upgrades/v15/testnet/guide.md

Errors in networks/osmosis-1/upgrades/v12/testnet/guide.md

Errors in networks/osmosis-1/upgrades/v4/cosmovisor.md
@SamantaTarun
Copy link

How do I find those links in the code?

@pysel
Copy link
Member

pysel commented Jul 2, 2023

hey @tarunsamanta2k20! You can find the broken link by checking paths in the generated report. For example:

Errors in networks/osmosis-1/upgrades/v13/testnet/guide.md

[404] https://docs.cosmos.network/master/run-node/cosmovisor.html | Cached: Error (cached)

the path to a file that contains a broken link is networks/osmosis-1/upgrades/v13/testnet/guide.md (which is this file) and you may find the broken link itself in the file by searching it with a text finding tool (command + F on macOS)

@SamantaTarun
Copy link

@pysel got it. But the problem is that those urls doesn't not exists anymore.

@inFocus7
Copy link
Contributor

inFocus7 commented Jul 3, 2023 •
edited
Loading

Ah yeah. As far as the locally referenced files go, this one for example

Errors in x/concentrated-liquidity/README.md
[ERR] file:///home/runner/work/osmosis/osmosis/x/concentrated-liquidity/img/SpreadRewardGrowthOutsideCalcuations.png | Failed: Cannot find file

Looks like in this commit, references to Fee Growth were replaced with Spread Growth, and the filename was updated even though we don't have the updated image name (or just an updated one in general).

Two options I can think of - for the specific case above - are:

  1. Reference the older image FeeGrowthOutsideCalculations, although it'll say "Fee Growth" in the image, while we refer to it as "Spread Reward Growth"
  2. Create updated image(s) with updated names + text.
    • I'm not well-versed on the product/field to know if FeeGrowth == SpreadRewardGrowth

Also if Tarun doesn't take it, I volunteer as tribute 🖐🏼

@pysel
Copy link
Member

pysel commented Jul 3, 2023 •
edited
Loading

@pysel got it. But the problem is that those urls doesn't not exists anymore.

yes, the point of these automatic broken links reports is to find links that are not working anymore for any reason and, if possible, to fix them

@pysel
Copy link
Member

pysel commented Jul 3, 2023

@tarunsamanta2k20 @inFocus7 thank you for your interest in this! this issue has a help wanted label, which means anyone is free to contribute in fixing the issue, if they want. hence, please, if you are interested, feel free to open a PR!

@inFocus7
Copy link
Contributor

inFocus7 commented Jul 3, 2023

Thanks! I opened a PR using my fork of the project and have 2 reviewers with 1 approval (#5728)

@inFocus7
Copy link
Contributor

With the above PR merged should this be closed or was there something missing? 👀

@pysel
Copy link
Member

pysel commented Jul 10, 2023

hey @inFocus7. sure. however, I thought it would be nice to automate this process. I created an issue on this matter, so if you are interested, feel free to check it out: #5806! thanks again for your contribution

@pysel pysel closed this as completed Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
automated issue Good first issue Help wanted report
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@inFocus7 @pysel @SamantaTarun