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

Testing external links #612

Open
jamesreprise opened this issue Aug 5, 2022 · 2 comments
Open

Testing external links #612

jamesreprise opened this issue Aug 5, 2022 · 2 comments
Assignees
@jamesreprise
Labels
priority: medium type: documentation type: feature

Comments

@jamesreprise
Copy link
Contributor

Problem to Solve

We have infrastructure for testing our internal links are correct, but not external links. This has given rise to errors:
#610
#611

Current Workaround

Spot them manually and fix them.

Proposed Solution

Check status codes of links at the very least to determine if the link is active. This might be too shallow but is a good 80/20 solution.

Additional Information

This is a thorny problem - we want to check that many external links are valid quickly. CI running this job in particular might be difficult: from an outside perspective, if some cloud IP starts hitting your site very quickly you might be inclined to ratelimit or block it entirely.
@jamesreprise jamesreprise mentioned this issue Aug 5, 2022
Closed
jamesreprise added a commit to jamesreprise/vaticle-docs that referenced this issue Aug 5, 2022
@jamesreprise
Fix Typo
8badb84 
## What is the goal of this PR?

We fix a typo in the link that was overlooked in typedb#610

## What are the changes implemented in this PR?

The typo is fixed, the link points to the correct destination. Furthermore, we have opened an issue to look at preventing this class of errors in the future: typedb#612.
@jamesreprise jamesreprise mentioned this issue Aug 5, 2022
Closed
@jamesreprise jamesreprise self-assigned this Aug 7, 2022
@izmalk
Copy link
Contributor

izmalk commented Dec 8, 2022

Shall we move this to the https://github.com/vaticle/web-docs ?

@izmalk izmalk mentioned this issue Dec 8, 2022
Open
@alexjpwalker
Copy link
Member

Shall we move this to the https://github.com/vaticle/web-docs ?

test-links is a CI job run on every git push to this repo, docs. We would most likely resolve this issue by updating test-links. So docs is the right place for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jamesreprise jamesreprise

Labels
priority: medium type: documentation type: feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@alexjpwalker @izmalk @jamesreprise