forrtproject.github.io icon indicating copy to clipboard operation
forrtproject.github.io copied to clipboard

Exempt content folder from review requirements?

Open LukasWallrich opened this issue 1 year ago • 5 comments

Ideally, project leads would be able to make minor content changes without waiting for approval - could the content folder be exempted from the requirement to have review by someone else?

If that does not work, maybe it should live in another repository (so that we can also have fewer people able to edit the more technical parts of the webpage)?

LukasWallrich avatar Jul 10 '24 13:07 LukasWallrich

This is a good suggestion, I believe we need to atomise the CODEOWNERS file a bit more and look into rulesets that will help enforce these.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets

DAKiersz avatar Jul 13 '24 12:07 DAKiersz

Hi Lukas! Team leads should absolutely have control over content changes. Although perhaps keeping one review might still be helpful for identifying typos etc.?

I explained the reason for two reviewers in another issue previously, here's what I said:

The reason we changed this to two reviewers was to prevent changes which break the website. A lot of previous approvals have been "looks good to me" approvals, in the sense that the person reviewing doesn't seem to check the code, or even outright admits that they don't know whether the untested code will work. As part of the IOI grant, we reviewed this and identified it as a potential weak point for future releases.

The vision for the two-person review system is that there would be:

  1. One technical reviewer - someone who understands the code and can actually check it. That is generally performed by myself, Dominik K., Sam G., Richard D., or Lukas W.
  2. One conceptual reviewer - does the proposed change make sense for FORRT's mission/vision? This generally comes from Flavio A., but can be done by anyone in FORRT's management.

You can think of this as analogous to peer review of a journal article. If they don't understand the conceptual framing and methodology, are they actually reviewing the paper?

TL;DR: it's primarily for safeguarding technical changes, but does seem largely unnecessary for content changes.

That being said, we need to clearly identify what's a content change and what isn't. For example, the recent Glossary changes were within the /content/ directory, but were technical changes (in the sense of changes to scripts which did not deploy as expected).

Potentially we could change the settings so that changes to markdown and image files only need one review, whereas changes to other file types need two. Looks like Dominik has identified a method to do that!

(Note: Edited for clarity & to merge two identical issues)

bethaniley avatar Jul 13 '24 12:07 bethaniley

I like the idea to separate this by file type rather than folder (as that also makes it easier to add static files)

LukasWallrich avatar Jul 27 '24 17:07 LukasWallrich

This issue has been inactive for more than 90 days. If there is no further activity, it will be automatically closed in seven days time. You can reopen the issue if it is still relevant.

github-actions[bot] avatar Sep 30 '24 02:09 github-actions[bot]

This issue has been automatically closed due to it being stale for more than 7 days. Please feel free to reopen if you still want this issue.

github-actions[bot] avatar Oct 08 '24 02:10 github-actions[bot]

This issue has been inactive for more than 90 days. If there is no further activity, it will be automatically closed in seven days time. You can reopen the issue if it is still relevant.

github-actions[bot] avatar Jan 18 '25 02:01 github-actions[bot]

Keep open

Lukas Wallrich 1001 Valegro House // London SE10 9LJ @.*** // +44 7591 975294 // +49 163 4704135 https://lukaswallrich.coffee

On Sat, 18 Jan 2025 at 02:18, github-actions[bot] @.***> wrote:

This issue has been inactive for more than 90 days. If there is no further activity, it will be automatically closed in seven days time. You can reopen the issue if it is still relevant.

— Reply to this email directly, view it on GitHub https://github.com/forrtproject/forrtproject.github.io/issues/136#issuecomment-2599475209, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOK6NGJ4SY6ADVL4ZJQCZBD2LG2YTAVCNFSM6AAAAABKU4YGSKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKOJZGQ3TKMRQHE . You are receiving this because you modified the open/close state.Message ID: @.***>

LukasWallrich avatar Jan 18 '25 16:01 LukasWallrich