search

replicatedhq / replicated-field-labs

Defines the Replicated Platform Hands-On Labs powered by the Instruqt platform
16 stars 30 forks source link

update customers page screenshot, fix typos and grammatical errors #280

Closed alicenstar closed 1 year ago

crdant commented 1 year ago

Thanks for the PR. I'm partial to keeping the contractions because I'm looking for a conversational tone. Wonder if @paigecalvert would like to weight in. I really appreciate the other fixes and would like to incorporate them, though I'm not 100% on how Instruqt scales the screenshots—looks like yours is substantially bigger than mine.

paigecalvert commented 1 year ago

Thanks for the PR. I'm partial to keeping the contractions because I'm looking for a conversational tone. Wonder if @paigecalvert would like to weight in. I really appreciate the other fixes and would like to incorporate them, though I'm not 100% on how Instruqt scales the screenshots—looks like yours is substantially bigger than mine.

We don't use contractions in the docs, but I'm not opposed to contractions in other material like labs, website content, blogs, etc. where we're shooting for a more casual/conversational tone. The main reason we don't use them in the docs is because they can be more difficult to translate, making the docs less accessible to non-native english speakers. That might not be as big of a concern for this case especially since I think the labs are often done as part of onboarding with someone from Replicated helping to guide the process.

alicenstar commented 1 year ago

@crdant I can change the contractions back, I still left in some (like "let's") and overall I feel the tone is still conversational due to the use of words like "really" and "just" (as an example), but I am not strongly opinionated here. :)

alicenstar commented 1 year ago

@crdant ready for review, I reverted the contractions!