observational-dev / oawiki

Repository for wiki.observational.space
https://wiki.observational.space/
Creative Commons Attribution Share Alike 4.0 International
2 stars 4 forks source link

Contributor and article edit log #21

Closed BakerBelays closed 8 months ago

BakerBelays commented 8 months ago

Currently we don't account for who wrote, edited, added, or changed things in an article.

A log of who committed changes to an article and who wrote those changes should be available to readers- think a standard wiki history tab.

A full history akin to wikipedia or otherwise is likely unsustainable or difficult, but something simple like a log with a short description of each change and the author would be plenty. We won't have hundreds of edits from dozens of authors, we'll probably have tens of edits from 5 or 6. I think Fextralife's implementation is more than enough, as shown below. It's much more archaic than wikipedia's, but still shows who was active in the article.

image

random-person-001 commented 8 months ago

I fear that decoupling the contributors log from the article content will eventually make it easier to forget to update the contributor log than if contributors were recorded in the files they contributed to. That said, I'm not entirely opposed to this approach

peytondmurray commented 8 months ago

We can do this with git history, but we'll probably need to extend one of the templates to render the history into the article, and write a little python to handle fetching the history while sphinx is building. This should be totally possible. Maybe we can render this into a little tab or show/hide widget at the bottom of each article?

peytondmurray commented 8 months ago

I propose showing this in a modal dialog. @BakerBelays @finderskuipers what do you think? We can also hide it inside a different kind of widget if that makes more sense.