Move over to our new labeling guide

[misaugstad]

Brief description of problem/feature

We've been developing a new version of the labeling guide with @jonfroehlich @devonsnyder and @yeisenberg in a Google Doc. We've done a lot of work in there, and we should get it polished up soon so that we can replace our current labeling guide with that one.

There's a question of whether to move it into the PS code in the HTML, like we have with our current labeling guide, or if we should just link to the Google Doc. I personally like the idea of leaving it in the Google Doc format, because it lets multiple members of the team make text edits more easily, it makes it much easier for someone on the team to find new screenshots or make new diagrams and add them right into the labeling guide, and we could allow the community to comment on it directly (which would be especially helpful for translations).

I imagine that we could link to the doc that's in the appropriate language given the language they selected in PS, and we could link to the other languages at the top of the Google Doc as well. Translators could comment on text that should be updated (or we can give certain translators edit access). I can add comments and tag translators when we add temporary text through Google Translate that should be updated.

Would help to address these issues: #2764 #3240 #2686 #1263

Remaining TODOs

• [ ] Polish the last bits of text and missing images, and remove the stuff that is specific to the validation study. Though the nice part is that it doesn't have to be that polished to start using it, since updates are easy with Google Docs :)
• [x] Update sharing settings. My suggestions is to make it so that anyone can comment, but our close team can edit.
• [ ] Send the document out to our translators, and make docs in each language that at least starts with some Google Translate text.
• [ ] Update the links on the website to point to the Google Doc labeling guide (open in a new tab so you they aren't fully taken away from the PS website).
• [ ] Optional: Make some updates to make it feel less overwhelming. Either by having better intro sections, moving some stuff to an appendix, etc.

[devonsnyder]

This sounds great, Mikey! I also like the idea of keeping it in Google docs to make updates and translations a bit easier. I changed the sharing settings so that the link now allows folks to comment but not edit. Editing abilities should still be available to you, me, Jon, Chu, Yochai, Molly, Judy, and Delphine. I can make some updates to that list as well.

If folks have time to go through and address some of those remaining comments and questions, that'd be great. Another task would be to find appropriate images where needed. Let me know if there is anything else I can do to help!

[misaugstad]

Awesome, thanks @devonsnyder! I updated the initial comment to make it a checklist, and checked the sharing settings :) Rolling the addition of images into the text polishing too. Similarly, I think that we just need it in a somewhat reasonable state to start sending people to the document, and we can continue to add images over time!

[misaugstad]

Maybe at the top of the document we can link to server-specific guides as well? I'm thinking about something like our deployment in Burnaby, where they would use the English-language version, but they have some things that they would do differently than in our US deployments. Those pages could just be summaries of the server-specific changes from our default labeling guide.