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

Possibility to add TAG repos to CLOTributor #303

Closed
aliok opened this issue May 11, 2023 · 7 comments
Closed

Possibility to add TAG repos to CLOTributor #303

aliok opened this issue May 11, 2023 · 7 comments

Comments

@aliok
Copy link
Member

aliok commented May 11, 2023

How can I add a TAG's repo to CLOTributor?

It would be nice to list this issue there for example: cncf/tag-contributor-strategy#140

@tegioz
Copy link
Contributor

tegioz commented May 11, 2023

Hi @aliok

One way of handling this would be to add a CNCF TAGs project (or any other similar name that fits better) and include that repo (and potentially others) to it. It was originally designed for projects in the sandbox/incubating/graduated path, but I don't see any major problem with this. Maybe something like this:

- name: cncf-tags
  display_name: CNCF TAGs
  description: CNCF Technical Advisory Groups
  repositories:
    - name: tag-contributor-strategy
      url: https://github.com/cncf/tag-contributor-strategy
      check_sets: []
      exclude:
        - clomonitor

We could exclude it from CLOMonitor to avoid confusions with the rest of the CNCF projects. There is one detail we'd need to address first though: some fields, like the project's maturity, are required, and they don't fit well for a case like this. So we should probably make them optional.

What do you think about adding a project like that @caniszczyk?

@aliok
Copy link
Member Author

aliok commented May 11, 2023

Thanks @tegioz for the quick response.

I like your YAML-driven visualization, it helps understanding better.

I like the approach, except TAG Contributor Strategy has 2 repos that it owns and I would prefer having both indexed by CLOTributor:

How about having a separate project for each TAG? Something like:

- name: cncf-tag-contributor-strategy
  display_name: CNCF TAG Contributor Strategy
  description: CNCF TAG Contributor Strategy
  repositories:
    - name: tag-contributor-strategy
      url: https://github.com/cncf/tag-contributor-strategy
      check_sets: []
      exclude:
        - clomonitor
    - name: mentoring-wg
      url: https://github.com/cncf/tag-contributor-strategy
      check_sets: []
      exclude:
        - clomonitor
- name: cncf-tag-env-sustainability
  display_name: CNCF TAG Environmental Sustainability
  description: CNCF TAG Environmental Sustainability
  repositories:
    - name: cncf-tag-env-sustainability
      url: https://github.com/cncf/tag-env-sustainability/
      check_sets: []
      exclude:
        - clomonitor

Altough TAG Contributor Strategy might be the only exception having 2 repositories, another effect of separation is that it might be better to not put tasks from various TAGs under the same bucket.

For example, if there's only 1 project for all TAGs, when I go to CLOTributor and click on CNCF-TAGs project there, I would see tasks from TAG-Security, TAG-Env-Sustainibility, TAG-Network, etc. Tasks in these TAGs can be pretty irrelevant to each other.

@tegioz
Copy link
Contributor

tegioz commented May 11, 2023

Sure, a separate project for each TAG sounds great 🙂

@tegioz
Copy link
Contributor

tegioz commented May 17, 2023

Hi @aliok

@caniszczyk is fine with this too, so we'll make the changes required to accommodate those projects (the required fields I mentioned the other day). Will ping you as soon as they're ready so that you can add the projects 🙂

@aliok
Copy link
Member Author

aliok commented May 17, 2023

@tegioz Sounds great! Thanks for looking into this!

@tegioz
Copy link
Contributor

tegioz commented May 19, 2023

Hi @aliok

The changes required to make this possible have been addressed in:

You can add the new projects to the data file when you are ready 🙂

Some tips:

  • Repository field check_sets is not required anymore, so you can omit it
  • Fields maturity and category are now optional as well, and they should probably be omitted for this case
  • It'd be great if you could add the light and dark logo url for each project (sample below)
  • Maybe it'd be good to leave the word CNCF out of the project display name. The reason is that the full name is a bit long and it doesn't fit well in some parts of the UI. If you can consider using some abbreviations that would help too.

Logos sample:

logo_url: https://raw.githubusercontent.com/cncf/artwork/master/other/tag-contributor-strategy/icon/color/tag-contributor-strategy-icon-color.svg
logo_dark_url: https://raw.githubusercontent.com/cncf/artwork/master/other/tag-contributor-strategy/icon/white/tag-contributor-strategy-icon-white.svg

@tegioz tegioz closed this as completed May 19, 2023
@aliok
Copy link
Member Author

aliok commented May 25, 2023

Thanks @tegioz

I am giving it a try here: cncf/clomonitor#1109

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants