search

SFDO-Community-Sprints / DLRS-Documentation

Repo to organize the documentation and Pages files for the DLRS project
https://SFDO-Community-Sprints.github.io/DLRS-Documentation/
BSD 3-Clause "New" or "Revised" License
6 stars 10 forks source link

Add "Last Updated" section to each page #40

Open coriobriensfdo opened 1 year ago

coriobriensfdo commented 1 year ago

If we add a "Last Updated" line with date and person to each page we can keep track of pages updates/accuracy going forward.

mkolodner commented 1 year ago

@tcdahlberg - Is there, by any chance, some kind of tool that can be installed into GitHub that would do this for us? (Based on the last commit for the page, add a block at the bottom listing when it was updated and by whom.)

tcdahlberg commented 1 year ago

@mkolodner, I did find a way to do this just now at your prompting. I have wanted this for the SEA site too, but you motivated me to figure it out. Here is what it looks like on my development version of SEA (near the bottom of the page)

https://tcdahlberg.github.io/

It is a bit involved, but I would be willing to install the necessary scripts for DLRS

mkolodner commented 1 year ago

Yes, please, @tcdahlberg ! (Unless anyone else objects? @sharicarlson13 @coriobriensfdo ?) Personally I would not include the comments tool, just the Last Modified info. But others might feel differently on that.

sharicarlson13 commented 1 year ago

@mkolodner @tcdahlberg Yes, please!

I'm okay not including the comments tool. Though we may want to consider in the future as the feedback piece.

coriobriensfdo commented 1 year ago

WOW this is awesome!! Thank you Thad!

I guess my question is, what is the downside to collecting feedback on the page? I could see folks using that to ask questions when we'd want to point them to the TBC group instead I guess....

mkolodner commented 1 year ago

I just tend to think all "comments" sections are nothing but an invitation to spam and trolls. Plus unless one of us is going to be monitoring all those comments, I think it could just be a black hole. At least TBC is a place we're watching.

coriobriensfdo commented 1 year ago

Agree and makes sense! Let's leave off for now and strategize our feedback plan as you suggest.

tcdahlberg commented 1 year ago

I wasn't actually showing off the comments section, though I can add that if you want. Commenting requires a github account to comment which cuts down on trolling. Comments become issues in your repository where you can deal with them (delete, etc). The idea is that you aren't creating a third party database somewhere to deal with comments and just using standard GitHub tech. At any rate, the last updated is very separate code from commenting.

coriobriensfdo commented 1 year ago

I wasn't actually showing off the comments section, though I can add that if you want. Commenting requires a github account to comment which cuts down on trolling. Comments become issues in your repository where you can deal with them (delete, etc). The idea is that you aren't creating a third party database somewhere to deal with comments and just using standard GitHub tech. At any rate, the last updated is very separate code from commenting.

Hmmmmmmmmm it would be pretty fantastic to have that one day...