Add a linter to validate external links

AdobeDocs / commerce-services

Source of the Commerce Services developer guide

https://developer.adobe.com/commerce/services/

Other

2 stars 12 forks source link

Add a linter to validate external links #75

Closed dshevtsov closed 11 months ago

dshevtsov commented 11 months ago

Purpose of this pull request

This pull request (PR):

Adds a plugin remark-lint-no-dead-urls to ensure that external URLs in Markdown pages are working. The linter returns warnings on https://www.php.net/ on working links in some reason (I assume server related issues) so I excluded this domain in the configuration.
Replaces or removes dead links

Internal ticket: COMDOX-156

Test

Failed validate job reporting about dead links.

dshevtsov commented 11 months ago

Request for help to the contributors whose changes were the last in affected lines:

[ ] @jhadobe please see a report about a dead link. Which link should I use instead?

jhadobe commented 11 months ago

Request for help to the contributors whose changes were the last in affected lines:

[ ] @jhadobe please see a report about a dead link. Which link should I use instead?

@keharper what link should replace https://github.com/magento/data-services-eap/tree/master/DataServices/docs/README.md#how-to-enroll ?

keharper commented 11 months ago

Pinging @erikmarr

erikmarr commented 11 months ago

@keharper I believe that should go here: https://github.com/magento-commerce/data-services/blob/af8404441889db83b27d06af1324b64b02305cd1/DataServices/docs/README.md#how-to-enroll

keharper commented 11 months ago

@erikmarr That's a very specific/weird branch to link to. Can the branch be changed to main?

https://github.com/magento-commerce/data-services/blob/main/DataServices/docs/README.md

erikmarr commented 11 months ago

@keharper yes that can be changed to main. The URL I posted was the result of a search. Thanks for catching that.

dshevtsov commented 11 months ago

@keharper, that's a private repository. It will still be reported as a dead link. If you insist on adding it to the public docs, let me know, I'll add it to the ignore config.

jhadobe commented 11 months ago

@dshevtsov @keharper @erikmarr I would propose that we remove the link entirely. After looking at the content, it seems to be referencing early enrollment to product recommendations etc, for 2019. I assume we do not need to direct anyone to outdated enroll data.

erikmarr commented 11 months ago

@jhadobe I think you're right. I vaguely recall setting that up for our beta users. I agree the link should be removed.