Add warning rule for Git links

[apinnick]

Closes #828

[github-actions]

🎊 Navigate the preview: https://redhat-documentation-vale-at-red-hat-843.surge.sh 🎊

[apinnick]

@aireilly I think I need your help. I can't seem to get the validation rules to work.

[aireilly]

I think this needs its own rule. What about:

---
extends: existence
message: Do not include a link to '%s' in documentation source unless it is explicitly approved.
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/github-links/
ignorecase: true
level: error
scope: raw
action:
  name: remove
tokens:
    - 'https:\/\/gitlab\.com\/.*'
    - 'https:\/\/github\.com\/.*'

Note Red Hat rules also need their own small reference page: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/reference-guide/

[apinnick]

I think this needs its own rule. What about:

...

I can give it a try.

[apinnick]

@aireilly Can you look at this? I'm still not sure about how to fix the validation rules.

[aireilly]

So your rules are looking for a slug after the URL, there will fire the rule:

https://github.com/project
https://gitlab.com/project

these will not:

https://github.com
https://gitlab.com

[apinnick]

So your rules are looking for a slug after the URL, there will fire the rule:

It worked! Will this rule really work?

[aireilly]

Are we sure that this directive (No Git links) applies to all projects under the Red Hat umbrella?

[apinnick]

Are we sure that this directive (No Git links) applies to all projects under the Red Hat umbrella?

It's in the RHSSG: External links.

[apinnick]

Shouldn't I be able to see this new rule in the surge.sh preview?

[aireilly]

No you need to create a page + update the nav.adoc. See #634 for reference

[aireilly]

Looks good I think this is nearly ready. Added a few small comments

[aireilly]

If you search for https://github.com/ in openshift-docs there are a lot of hits. I wonder if we set scope: sentence will that "tune" for less false positives? openshift-docs are allowed to use https://github.com/openshift/* links.

Maybe add some exceptions?

exceptions:
  - 'https://github.com/openshift/*'

[aireilly]

/lgtm