ufosc / club-website

The official remodeling of The Open Source Club website
https://ufopensource.club
MIT License
9 stars 14 forks source link

Adding Progress Reports to the Website #70

Open logandgsmith opened 5 years ago

logandgsmith commented 5 years ago

Would there be interest in hosting progress reports? I know in the past we've talked about project leads giving status reports to the club, but perhaps we should just publish them to the website instead!

Option 1: Allow Users with "Project Lead" Status to Submit Progress Reports

Prerequisite Work

This would be the heavier option for this system. We'd need to do a few things to implement it.

Base Work

After we accomplish these, we could begin implementing the progress report system which would include the following base features.

Stretch Goals

After the base features are implemented, we will want to add (a lot!) more polish onto the reports. These are features that would be nice to have, but only after we have a stable base.

Option 2: Pull reports from GitHub

This option would involve less writing and changes on the website, but it's also a less interesting option over time. For this, we would use the GitHub API to pull a report.md file (which project leads would write) from the project repos. This would get rid of the need to create an editor on our site, and fast-track getting the page up. If enough people want this feature, we can discuss it, but Option 1 seems like a much better option to me.

swiftlee commented 5 years ago

I think this has a good point to it. I think the easiest way to implement this is to link with the Discord bot and allow for project leads to push their progress report.

Having an editor would be something to talk about, but it just depends on how many people prefer one over the other.

I 100% think the report.md file would be the best option out of these three though.