top-meta icon indicating copy to clipboard operation
top-meta copied to clipboard

Display Authors on Lesson Page

Open KevinMulhern opened this issue 3 years ago • 0 comments

Title Author Date
Display Author on Lesson Page Kevin 23-10-2021

Display Author on Lesson Page

Summary

Simply displaying the authors avatar and name on the lesson page. It would look similar to the author component Dev.to have on their articles: Screenshot 2021-10-23 at 13 12 24

Motivation

Writing content for the curriculum is hard and one of most difficult things to get contributions for on TOP. Displaying the author on the lesson page would provide extra recognition and incentive for writing lessons.

Suggested implementation

  • The original author that created the lesson initially should be displayed. To give recognition to editors we can provide a link to the lesson on GH to view editors who have made any changes to the lesson.
  • The author would be set in the seeds file where the lesson record is created. This gives us the ability to change the author if a significant rewrite happens where virtually none of the original content is left.
  • We can make the authors model flexible so multiple authors can be attributed to a lesson.

Drawbacks

There will inevitably be many different authors for individual lessons within courses. Could this leave a bad impression? such as the course seeming disjointed?

It could be time consuming and difficult to find some of the original authors of existing lessons. The Github history is a bit muddled as we broke out the curriculum into separate repos for each course at one point and later merged them back into the one repo again. Some Github history sleuthing may be required for a few lessons to get the original authors.

Alternatives

N/A

KevinMulhern avatar Oct 23 '21 12:10 KevinMulhern