search

pygame-community / pygame-ce

🐍🎮 pygame - Community Edition is a FOSS Python library for multimedia applications (like games). Built on top of the excellent SDL library.
https://pyga.me
822 stars 131 forks source link

Create CI for automated project Wiki #1859

Open gresm opened 1 year ago

gresm commented 1 year ago

GitHub Wiki is a good place for project documentation, but lacks flexibility of contributions that come with issues and pull requests. Because project wiki is a separate git repository, it is possible to automate process with GitHub Actions for pushing the changes form the main repository pygame-community/pygame-ce.git to pygame-community/pygame-ce.wiki.git. Such automation system was already implemented before (as seen in this article), so it is not necessary to invent new technology.

MyreMylar commented 1 year ago

That is cool to know about.

I don't believe there is any GitHub enabled way to stop our pygame-ce team members from being able to edit the wiki the normal way (via the wiki tab) so having this method would not enforce using PRs to update the wiki as many people would still just be able to edit it.

Not opposed, just noting how GitHub implements the wiki pages.

Matiiss commented 1 year ago

I don't believe there is any GitHub enabled way to stop our pygame-ce team members from being able to edit the wiki the normal way (via the wiki tab) so having this method would not enforce using PRs to update the wiki as many people would still just be able to edit it.

However, people who are not members of the team would be able to propose and submit changes for the wiki, so this sounds like a fine idea to me.