Fix Broken Links in grid-docs - Githubissues

gridai / grid-docs

Public repository for managing Grid Platform documentation synced with gitbook on docs.grid.ai

20 stars 13 forks source link

Fix Broken Links in grid-docs #308

Open krishnakalyan3 opened 2 years ago

krishnakalyan3 commented 2 years ago

To check for broken links I used a python-link checking library. Perhaps it's a good idea to validate all links before a commit?.

python -m pip install linkcheckmd
linkcheckMarkdown .

changelog.md

platform/11_known-issues.md

platform/10_tips-and-tricks.md

platform/1_Billing/billing-rates.md

[ ] https://docs.grid.ai/features/runs/interruptible-machines#interruptible-machines

features/runs/1_README.md

[ ] https://docs.grid.ai/features/runs/sweep-syntax x2 occurrence

features/runs/2_private-repos.md

[ ] https://docs.grid.ai/features/runs/faq.md

features/runs/1_Creating Runs/1_Basic Runs/2_Adv Runs/3_sweep-syntax.md

[ ] https://docs.grid.ai/features/runs/faq.md

features/runs/1_Creating Runs/2_Adv Runs/3_creating-runs-from-config.md

[ ] https://docs.grid.ai/getting-started

features/runs/1_Creating Runs/2_Adv Runs/2_creating-runs-with-dockerfile.md

[ ] https://docs.grid.ai/getting-started

features/runs/1_Creating Runs/2_Adv Runs/5_auto-resume-experiments.md

[ ] https://github.com/PyTorchLightning/pytorch-lightning/blob/master/pl_examples/fault_tolerant/automatic.py

features/sessions/changing-instance-type.md

[ ] https://docs.grid.ai/features/runs/interruptible-machines#interruptible-machines

features/sessions/8_how-to-ssh-into-a-session.md

[ ] https://github.com/gridai/grid-docs/blob/doc-118-docs-add-troubleshooting-tip-to-ssh-docs/docs/features/sessions/how-to-ssh-into-a-session.md#step-0-create-an-ssh-key x2 occurrence

examples/running-with-different-frameworks/running-julia-programs.md

[ ] https://github.com/rlizzo/TuringCLIExample/blob/main/fit.jl

krishnakalyan3 commented 2 years ago

cc: @essiequoi @pritamsoni-hsr what do you guys think. Should we add a link checker to our CI?.