#36 docs author credit list
Closed: Fixed 2 years ago by darknao. Opened 6 years ago by mattdm.

The front page has a message thanking all docs writers and translators. Credit is currency in open source — let's make this list more visible. Let's make a list crediting writers, editors, and translators all in one place.


+1.

  • Does everyone feel like a good start to this is to use the git history and the existing Authors pages from the XML pages?

  • How do you want to display this information, it will be a longish list.

Also, I am not sure how to get translation credits, other than asking l11n for them. Any other ideas?

  1. Yes, git history and existing pages seems like a good start.

  2. I dunno. I was thinking "longish list". Maybe separate out by authors, editors, and translators (with duplication as appropriate).

  3. Yeah, ask G11N.

I think we also want "authors" at the bottom of each quick docs page. Not sure if that should be done by software or just made part of the document.

I think we should maintain it manually and do a one-time dump from the history. We also need to acknowledge that we are going to miss people.

Manual is suggested because of things like @rkratky doing the final clean up commits on everyone's additions, some of which may not have been in surviving contributor authored commits.

Manual maintenance doesn't seem awesome to me. With some automation it is possible to track period or years when people were active, spot potential writers, add other ratings and metrics.

Manual maintenance doesn't seem awesome to me. With some automation it is possible to track period or years when people were active, spot potential writers, add other ratings and metrics.

Agreed. Perhaps we could write a script to update the files periodically. Many of the repos are now "cleaned" in order to make clone times shorter. (Old repos had years of translations and built html committed that is no longer needed or part of hte process). We need a process that is durable enough to accept that the history from those repos is true without needing the commits to regenerate it.

@abitrolly is this something you'd like to work on?

It is something I'd like to work with if the build system is fixed when I got my next free time slot. )

Closing as authors are now listed at the bottom of each pages, and we're unlikely to automate anything more in the foreseeable future.

Metadata Update from @darknao:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)

2 years ago

If I would have to implement it, I would start with this script https://sourceforge.net/p/roundup/code/ci/default/tree/scripts/contributors.py (public domain).

Login to comment on this ticket.

Metadata