search

cockroachdb / docs

CockroachDB user documentation
https://cockroachlabs.com/docs
Creative Commons Attribution 4.0 International
187 stars 453 forks source link

Provide more helpful reference link to "imperative mood" #11938

Open ankush981 opened 2 years ago

ankush981 commented 2 years ago

Exalate commented:

The Style Guide (https://github.com/cockroachdb/docs/wiki/Style-Guide) talks about imperative mood being the preferred one. However, to those not steeped in grammatical technicalities (such as yours truly!), the Wikipedia link isn't a great help. It doesn't provide a friendly, gradually-building-up tutorial on what mood is and what imperative mood is, and so on; moreover, it's a generic article on imperative mood and covers languages other than English too, resulting in more effort and confusion for the learner.

My proposal: change the link to something more helpful/beginner-friendly. It can even be a set of links to explain different shades of the idea.

If you agree, I'd also request that this be assigned to me, as I'm desperately looking for docs to contribute to! 😄

Jira Issue: DOC-1757

gemma-shay commented 2 years ago

Hi @ankush981, your proposal sounds great to me. I'm going to assign you to this issue and can review any changes you make to the Style Guide wiki page. If you don't have access to edit the page, you can just comment your updates here and I'll put them in for you. Thanks for opening this!

jseldess commented 2 years ago

Due to some internal constraints at the moment, I have to unassign this issue from your name, @ankush981, but please do feel free to contribute on it.