Set up link checker in private repositories
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
We already have a script for checking links in other repositories: https://github.com/Qiskit/documentation/blob/main/scripts/js/commands/checkInternalLinksFromOtherRepo.ts. However, we haven't updated it since changing how links work that we now expect a /docs and /learning prefix. We should get this script working.
That also means regenerating our saved links:
When working on this, use our branch functions-template, which is how we run our scripts with private repositories. First, run npm run check:internal-links and ensure it's breaking; if not, add some test links to the files. Then, fix the code on main, and open a PR to update functions-template to use the new commit & to add npm run check:internal-links to the ./check script.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with scripts/js/commands/checkInternalLinksFromOtherRepo.ts and run npm run check:internal-links on the functions-template branch to confirm the current failure. Inspect package.json at the saved-links command and update the checker and generated links on main. Done means functions-template uses the new commit and adds npm run check:internal-links to ./check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100