Increase .clomonitor.yml configuration

[jeefy]

Feel free to close this and break it up into separate issues, but I want to capture all the ideas under one since they all involve .clomonitor.yml :)

• We should be able to specify alternative locations for some checks
  For example, https://github.com/project-akri/akri has the header Community, Contributing, and Support, which also links to their Contributing page https://docs.akri.sh/community/contributing.
  Being able to specify in the YAML something like contributing_url: https://docs.akri.sh/community/contributing and pass the check would be great
• We should be able to skip/pass certain checks in .clomonitor.yml. For example(s), Akri or Envoy explicitly state on their docs that they're part of the CNCF. This is technically an accepted path (See [SANDBOX PROJECT ONBOARDING] Akri sandbox#229)

[tegioz]

Hi @jeefy

We should be able to specify alternative locations for some checks
For example, https://github.com/project-akri/akri has the header Community, Contributing, and Support, which also links to their Contributing page https://docs.akri.sh/community/contributing.
Being able to specify in the YAML something like contributing_url: https://docs.akri.sh/community/contributing and pass the check would be great

A user brought this up recently and we mentioned we were considering making it configurable via .clomonitor.yml.

However, we're not really sure if this the right thing to do, specially for documentation related checks. The reason is that IMHO it'd be great if we could encourage projects to make this information a bit easier to discover by final users. Having this information in .clomonitor.yml would make it much easier for us to check, but probably wouldn't help users.

So in addition to support some standard well known locations, some checks are now able to detect certain headers in README files (checks like adopters, governance, changelog, roadmap, etc). This way projects can have this information at their preferred location and users have a better chance of finding it when going through the README file. The Kubernetes and Cilium projects are making CLOMonitor happy this way 🙂

The Contributing check does not support headers in the README file yet, but we'll take care of it tomorrow 😉

[tegioz]

The Contributing check does not support headers in the README file yet, but we'll take care of it tomorrow 😉

Done, Akri's contributing check is now passing.

[jeefy]

Could we perhaps pass the Trademark check if there's an additional Header in the README.md or a TRADEMARK.md exists in the docs (that contains what we're expecting)?

I think that'll give enough flexibility and control to close this out. I'm happy to close this issue and create a new one for this if that's easier. :)

[tegioz]

Could we perhaps pass the Trademark check if there's an additional Header in the README.md or a TRADEMARK.md exists in the docs (that contains what we're expecting)?

Sure, this is not a problem. However, I thought this was a requirement as mentioned in the website guidelines document:

7. Website footers must include trademark guidelines by either linking to Trademark Usage (directly or via a "Terms of service" page), or by including the following text: "The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see Trademark Usage".

@caniszczyk requested this one in cncf/toc#73, maybe he can confirm 🙂

[jeefy]

Sure, this is not a problem. However, I thought this was a requirement as mentioned in the website guidelines document:

We have some edge cases (like Akri) where they don't have a full blown website. In this case they're using GitBook for their website (https://docs.akri.sh/). That doesn't have control over Headers or Footers, so we should support checking for the Trademark disclaimer in an alternative place.

Happy to wait for @caniszczyk to weigh in.

[caniszczyk]

If a project doesn't have a website then that's a problem, we should build them one :)

…

On Tue, Mar 8, 2022 at 9:20 AM Jeffrey Sica ***@***.***> wrote: Sure, this is not a problem. However, I thought this was a requirement as mentioned in the website guidelines document <https://github.com/cncf/foundation/blob/main/website-guidelines.md>: We have some edge cases (like Akri) where they don't have a full blown website. In this case they're using GitBook for their website ( https://docs.akri.sh/). That doesn't have control over Headers or Footers, so we should support checking for the Trademark disclaimer in an alternative place. Happy to wait for @caniszczyk <https://github.com/caniszczyk> to weigh in. — Reply to this email directly, view it on GitHub <#140 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAPSILMA5LBZJWKTYSDRBTU65V4VANCNFSM5QALC5VA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Cheers, Chris Aniszczyk https://aniszczyk.org

[tegioz]

That doesn't have control over Headers or Footers, so we should support checking for the Trademark disclaimer in an alternative place.

We are not checking for the trademark disclaimer to be in any specific location, so as long as the regex below matches the content returned when fetching the website document, the check should pass. In the Akri case, it could be added to the What is Akri or Why Akry sections, for example, and it should work. Just in case that helps 🙂

https://(?:w{3}\.)?linuxfoundation.org/trademark-usage

[jeefy]

That's super helpful! Thanks!

[tegioz]

I think we can close this one now, please feel free to reopen if needed.