-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA512 On 2017-05-26 05:57, tokidev wrote: > Hi, folks! > > On your website, there at least two Markdown conventions in contentual > conflict. > > At [1] in the section "Markdown Conventions", the second point says: > >> * Hard wrap Markdown lines at 80 characters. > > At [2] in the section "Markdown Conventions", the second point says: > >> * Insert a newline at the end of each sentence. >> >> * Rationale: This practice is most appropriate for source that >> consists primarily of natural language text. It results in >> the most useful diffs and facilitates translation into other >> languages while mostly preserving source readability. > > As long as there are no special reasons for these contradictory rules, I > suggest to resolve that conflict, e.g. by deleting one of those > convention lists and link to the other instead. > > I prefer the latter convention point to keep (since most links point to > these [2] conventions and because of the given rationale -especially the > translation thing). > > > Why is this important? Well, there are lots of Markdown files with more > than one sentence per line or with partial sentences per line. Both > result in very ugly phrases to translate at Transifex. :S To be honest, > I lose my desire to translate such things. I guess that other > translators think alike. > > > Kind regards, > Tobias >
Thanks, Tobias. The explanation for this contradiction is very simple and boring: When we decided to change our convention to inserting a newline at the end of each sentence [3], we updated the Markdown Conventions on the Qubes website, but we forgot to update them on the GitHub README. This is exactly why we don't like to have the same content in more than on place: it inevitably becomes desynchronized. The right solution is to deduplicate the content, so I've replaced the duplicate content on the GitHub README with a link to the Documentation Guidelines. Apologies for the confusion, and thank you for pointing it out. > [1] https://github.com/QubesOS/qubesos.github.io/blob/master/README.md > [2] > https://github.com/QubesOS/qubes-doc/blob/master/basics_user/doc-guidelines.md [3] https://github.com/QubesOS/qubes-issues/issues/2639 - -- Andrew David Wong (Axon) Community Manager, Qubes OS https://www.qubes-os.org -----BEGIN PGP SIGNATURE----- iQIcBAEBCgAGBQJZKMgAAAoJENtN07w5UDAwlksP/0qTujBwnMmaG5UTEiLhgIpD DUWTB66gV9kuKuahV02x1U/vxSC6L54Jwu303ZrJWEVb6f8Qls/SY4pfQe2IA6lB YJs0kUxvpJSHlZGuAEYsSLolBwJa/hMgGQIuX29w8DFJ1vBK7LKGT0T2rPxDxXJB gBVNZUtrkzqkPgkTZVIUeY8GlO0v2BaSKFNOT7CRlB2CsmA5EIJ26Sny9ad/cw4l U0s6jv24EFR0rB+H/jmXRY45Plm3rVzjzgHrqxOnzneb7dPISB/XLbesNkEmkIBT PFcDPRQEUG4EbyYCnn32KvoyNuq4OJuNI7YASwdY7y1rua0CSj12wY4LMcRVPYUP YPNWZf0I1Amg+QgbSUwKbmefXXlEQcYBqPhEkmI0B9FKJjITnr+tC4Bvri462DQc txNnlVQWaqpMEpd9LRgbN8eECTQON60RzdtTuLlQ8C3aMTbqMkMwI9hYfZzwNiVY t1q360et8wuj/ExEa1G58yMHyO53HrIJ5PBKff4HrLYQ6MwA26hpNOmlzwnKvYYe VpAkTGB1ppky8IyNszZqAmmX57l4Olsa9xqnGY5T3R9Yp/d9SkJ9vE8YUhWNeq2r B51F4O5vGeOvvI8uG96RDHtrXa0oSPZS5hJSGGuyBPDpubcK3tMHTLHeSOqNiE0U 2bJ0Qks5WD3RPjmNWll4 =+i/1 -----END PGP SIGNATURE----- -- You received this message because you are subscribed to the Google Groups "qubes-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/qubes-devel/a282ce61-a8cc-7ac8-4cc6-d1733d0365ab%40qubes-os.org. For more options, visit https://groups.google.com/d/optout.
