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.

Sign up for GitHub

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

Jump to bottom

Solution to accelerate solidproject.org updates' publishing #222

Closed
wants to merge 1 commit into from
Closed

Solution to accelerate solidproject.org updates' publishing #222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ The solidproject.org website is linked to the [`master` branch of the GitHub rep

Anyone can make suggestions by commenting or submitting pull requests to the [`staging` branch of solid/solidproject.org](https://github.com/solid/solidproject.org/tree/staging) to be reviewed by Editors, and be approved by the Solid Director before they go to `staging`.

The Editorial review of website suggestions must happen within 24 hours of submitting the pull request. If the Editorial review of the website suggestion does not happen within 24 hours, then the website suggestion can be published with Creator review as long as the suggestion is technically in line with approved Solid website content.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

48 hours seems more reasonable

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Surely one of six of the Editors can check the occasional website suggestions once every 24 hours. Perhaps you could arrange it between yourselves to take turns so you only have to check once every six days.

If that's too much of a burden then an alternative could be to trust the Creators to review the website suggestions as long as they are technically in line with previously approved website suggestions. If suggestions are not technically in line with previously approved website suggestions then it could go to the Editors for review.

Copy link
Contributor

@RubenVerborgh RubenVerborgh Jul 24, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Several things are problematic with this, I will list the most important ones below:

  1. The assumption that the problem would be related to editors reacting slowly. There seems to be plenty of evidence to the contrary, including https://github.com/solid/solidproject.org/pulls?q=is%3Apr+is%3Aclosed+reviewed-by%3Arubenverborgh

  2. The assumption that there would be a trust problem, as opposed to a quality check that is very common in open-source projects (hence the built-in review functionality in GitHub).

As such, I propose that we first aim to understand what exactly is causing slowdowns, before trying to fix anything. Clearly, the two assumed causes (slow editors / lack of positive feedback) are not the correct ones; hence, this fix can't be the correct one either. Also, note that the issues in #217 are considered to be addressed by the existing process, which simply is not followed consistently. I have created and assigned this issue to identify the causes: #226


The Editorial review must be green pen, not red pen edits i.e. edits cannot say that text suggestion is inadequate without actively stating what the text should become or what specific text should be removed completely for the suggestion to become adequate. Red pen Editorial reviews can be ignored.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to write this.


Spelling, grammar, broken links, and other minor changes do not need to be approved by the Solid Director and can be updated or approved directly in `staging` by the Creators. Changes larger than that, but that do not significantly alter the website content (such as referencing community activity outside of the website) also do not need to be approved by the Solid Director in order to be applied to `staging`, as long as they have been approved by one of the [Editors](https://github.com/solid/process/blob/master/editors.md).

Creators can move changes in `staging` to `master` (and hence solidproject.org) at any time, since `staging` will only contain approved changes.
Expand Down