search

chaoss / wg-metrics-models

Working Group for Metrics Model
MIT License
13 stars 22 forks source link

Added permanent links to the metrics models pages #104

Closed nwanduka closed 11 months ago

nwanduka commented 11 months ago

This PR resolves #102

Notes for reviewers:

  1. I've added permanent links to all the metrics models pages.
  2. I noticed that the metric "safety" appears twice in the csv file. They have different web & permanent links (one is just "safety" and the other is "community safety"). But the GitHub directories are the same; they both lead to the safety.md file. There's just one folder for safety. There's none for community safety. image
  3. I also noticed that there's a "community welcomingness" folder but it wasn't captured in the csv file. Is this intentional? image

@geekygirldawn for your review.

geekygirldawn commented 11 months ago

I think that community safety was probably renamed to safety at some point? If so, we probably shouldn't have both listed on https://chaoss.community/kbtopic/all-metrics-models/ which where my script found both of them.

I'm also curious why the welcomingness metric model is in the repo, but not on the web page.

Thanks for catching both of these inconsistencies! They both look like bugs to me, so I think we should file both of them as issues in this repo. Would you mind creating the issues and tagging @ElizabethN and me in them?

nwanduka commented 11 months ago

I think that community safety was probably renamed to safety at some point? If so, we probably shouldn't have both listed on https://chaoss.community/kbtopic/all-metrics-models/ which where my script found both of them.

I'm also curious why the welcomingness metric model is in the repo, but not on the web page.

Thanks for catching both of these inconsistencies! They both look like bugs to me, so I think we should file both of them as issues in this repo. Would you mind creating the issues and tagging @ElizabethN and me in them?

Of course, I don't mind creating issues around these inconsistencies. And if after reviewing them I discover that I can take on the issues, I'd be more than happy to work on them.

Just to be clear, here's a description I propose for the two issues:

  1. On the Metric Model website, we have "safety" listed twice. It appears a second time as "community safety". Ideally, there should be just one Safety page, since the current pages both contain the same information. We need to remove the "community safety" page.
  2. The "Community Welcomingness" metric model is in the GitHub repo but is not on the website. The desired state is to have a dedicated page for the Community Welcomingness metric model, like the others listed on the website.

Do these descriptions capture the crust of both issues?