Fix links from UI to docs
In this MR, pipeline tests were updated and have shown that we have more broken links from the UI to the docs.
This issue is to track the list of broken links, so that we can potentially fix them.
Instructions
- From the following table, click on a link that doesn't have an associated merge request.
- Under the highlighted line is the
helpPagePathhelper containing the link to fix. Sometimes it's the URL, sometimes it's just the anchor link. To visit that URL and see if it's valid, prepend withhttps://gitlab.com/help/. This however only works if the docs live in thegitlab-org/gitlabrepo. If you're linking to another repo like runner, Omnibus, etc., use the full URL. - Replace the broken link with a valid one. Sometimes it might be as simple as removing the anchor.
- Remove the highlighted line (
// eslint-disable-next-line local-rules/require-valid-help-page-path). - If a file has multiple broken links, repeat the previous steps to fix all of them.
- Optional. If the link ends in
.htmlor.md, remove the extension. - Create a merge request.
- To fix any job failures:
-
You may need to run the following to fix any linter errors:
yarn run prettier --write <path/to/file> -
For
jesterrors, check the failed jobs if any spec files are mentioned. If so, you might need to update the links in them as well. -
The spec snapshot might need an update too:
yarn jest --watchPress p and paste in fullpath to the spec file. If there's a snapshot, the test will fail. Press u to update the snapshot.
-
Remaining
None!
Not done, no clear group
| Page | Link | Question |
|---|---|---|
| help_center.vue | No change needed: Any empty helpPagePath function resolves to `/help` so I think this is correct? |
|
| fetch.js | Help needed on this one | |
| help_page_link.vue | !160965 (comment 2020301053) | No change needed |
| subscription_details.vue | ee/subscriptions/constants |
Needs research. |
Done
Edited by Suzanne Selhorn