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: test broken links in website #1912

Merged
merged 40 commits into from
Sep 7, 2022
Merged

Conversation

gastonfournier
Copy link
Contributor

@gastonfournier gastonfournier commented Aug 11, 2022

About the changes

Adds broken link checks after building the website.
Initially, the workflow is meant to be triggered manually

@vercel
Copy link

vercel bot commented Aug 11, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Ignored Deployments
Name Status Preview Updated
unleash ⬜️ Ignored (Inspect) Sep 7, 2022 at 1:25PM (UTC)
unleash-docs ⬜️ Ignored (Inspect) Sep 7, 2022 at 1:25PM (UTC)
unleash-monorepo-frontend ⬜️ Ignored (Inspect) Sep 7, 2022 at 1:25PM (UTC)

@github-actions
Copy link

github-actions bot commented Aug 11, 2022

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements
88.74% (-2.63% 🔻)
6842/7710
🟡 Branches 79.16% 1090/1377
🟢 Functions
82.56% (-3.66% 🔻)
1927/2334
🟢 Lines
89.09% (-2.21% 🔻)
6339/7115

⚠️ Details were not displayed: the report size has exceeded the limit.

Test suite run success

1144 tests passing in 188 suites.

Report generated by 🧪jest coverage report action from 604229b

@thomasheartman
Copy link
Contributor

thomasheartman commented Sep 5, 2022

@gastonfournier What's the status on this? 😄 Seems like a great feature that I'd be excited to get in: let me know what I can do!

Copy link
Contributor Author

@gastonfournier gastonfournier left a comment

Choose a reason for hiding this comment

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

Do create the issue

.github/workflows/check_links.yaml Outdated Show resolved Hide resolved
.github/workflows/check_links.yaml Outdated Show resolved Hide resolved
@gastonfournier
Copy link
Contributor Author

Based on https://github.com/Unleash/unleash/runs/8228984635?check_suite_focus=true it does not make sense to run always

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

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

Nice work! Let's get it in 🚂

@gastonfournier gastonfournier merged commit 6ef8c78 into main Sep 7, 2022
@gastonfournier gastonfournier deleted the docs/find-broken-links branch September 7, 2022 13:31
andreas-unleash pushed a commit that referenced this pull request Sep 12, 2022
## What

This PR fixes some broken links that have been hanging around in the
docs for what seems like a very long time.

## Why

As discovered by the link check in #1912, there are a fair few broken
links in the docs. Everyone hates broken links because it makes it
harder to understand what they were supposed to be pointing at.

## How

There are 3 types of links that have been fixed:
- Links that should have been internal but were absolute. E.g.
  `https://docs.getunleash.io/path/article` that should have been
  `./article.md`
- External links that have changed, such as Slack's API description
- GitHub links to files that either no longer exist or that have been
  moved. These links generally pointed to `master`/`main`, meaning
  they are subject to change. They have been replaced with permalinks
  pointing to specific commits.

-----

* docs: fix slack api doc link

* docs: update links in migration guide

* docs: fix broken link to ancient feature schema validation

* docs: update links to v3 auth hooks

* docs: update broken link in the go sdk article

* Fix: use permalink for GitHub link

* docs: fix wrong google auth link
andreas-unleash pushed a commit that referenced this pull request Sep 12, 2022
The action triggers manually as a first step to test this functionality. In the near future, we might schedule it
andreas-unleash added a commit that referenced this pull request Sep 14, 2022
* PublicSignupTokens

* bug fix

* bug fixes and test

* bug fixes and test

* bug fixes and test

* Add feature flag

* tests

* tests

* Update 20220908093515-add-public-signup-tokens.js

Bug Fix

* task: use swc instead of ts-jest (#2042)

* Add a counter for total number of environments (#1964)

* add groupId to gradual rollout template (#2045)

* add groupId to gradual rollout template

* FMT

* Improve tabs UI on smaller devices (#2014)

* Improve tabs UI on smaller devices

* Improve tabs UI on smaller devices

* bug fix

* add proper scrollable tabs

* removed centered from Tabs (conflicts with scrollable)

* PR comments

* 4.15.0-beta.10

* Fix broken doc links (#2046)

## What

This PR fixes some broken links that have been hanging around in the
docs for what seems like a very long time.

## Why

As discovered by the link check in #1912, there are a fair few broken
links in the docs. Everyone hates broken links because it makes it
harder to understand what they were supposed to be pointing at.

## How

There are 3 types of links that have been fixed:
- Links that should have been internal but were absolute. E.g.
  `https://docs.getunleash.io/path/article` that should have been
  `./article.md`
- External links that have changed, such as Slack's API description
- GitHub links to files that either no longer exist or that have been
  moved. These links generally pointed to `master`/`main`, meaning
  they are subject to change. They have been replaced with permalinks
  pointing to specific commits.

-----

* docs: fix slack api doc link

* docs: update links in migration guide

* docs: fix broken link to ancient feature schema validation

* docs: update links to v3 auth hooks

* docs: update broken link in the go sdk article

* Fix: use permalink for GitHub link

* docs: fix wrong google auth link

* 4.15.0

* 4.15.1

* docs: update link for symfony sdk (#2048)



The doc link appears to have pointed at an address that is no longer reachable. Instead, let's point to the equivalent GitHub link

Relates to and closes #2047

* docs: test broken links in website (#1912)

The action triggers manually as a first step to test this functionality. In the near future, we might schedule it

* Schedule link checker action (#2050)

Runs at 12:30 UTC on Mon, Tue, Wed, Thu and Fri

* fix: add env and project labels to feature updated metrics. (#2043)

* Revert workflow (#2051)

* update snapshot

* PR comments

* Added Events and tests

* Throw error if token not found

Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Gastón Fournier <gaston@getunleash.ai>
Co-authored-by: Ivar Conradi Østhus <ivarconr@gmail.com>
Co-authored-by: sjaanus <sellinjaanus@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants