Re: Debian Publicity Style guide proposal.
Hi Justin,
On 8/17/24 03:33, Justin B Rye wrote:
> Donald Norwood wrote:
>>
>> Could I invite you to author the *Official* Publicity/Press team style
>> guidelines? This document would help us to keep the same style, grammar, and
>> punctuation across the variances of the author's native language(s).
>
> Thanks, this seems like a good idea. I already have a "personal
> debian-l10n-english style-guide page" from the days of the Smith
> Project template reviews
> http://jbr.me.uk/linux/esl.html
> (and I'd been thinking of giving that an update this year), but this
> would need a slightly different type of advice.
Very well done. We definitely have the right person for this outreach. :)
>
>> We would of course maintain this in its own repository perhaps called: Debian
>> Publicity Styling Guide or something to that affect.
>
> This may involve some grumbling about how I don't understand git, but
> the reason for that is mostly that I've never done anything that was
> made easier by putting it under version control, so maybe this would
> be a good opportunity for some practice.
It's easy once you get used to it. It does seem daunting at first to be
completely fair with you. Version control really shines with multiple parties
working on something due to how you can see the difference in the commits AND
the comment feature which is used to explain what the commit was. Give it a week
and you'll wonder why you were never on it.
We've started the repository in our git branch:
https://salsa.debian.org/publicity-team/styleguide
Assuming you have a salsa.debian.org account, to access/read/edit:*
apt install git
git clone https://salsa.debian.org/publicity-team/styleguide
cd styleguide
vi $filename
git commit -m "comment on what change you made" $filename
(-m means message IIRC)
git push (push your commit to the repository)
If you add a file to the repository:
cd styleguide
vi $newfilename
git add $newfilename
git commit -m "comment about the new file" $newfilename
git push
The above works for adding directories as well to the repository.
*In case you knew that, but more so for others reading the list wondering how
git works. In either case you really cannot screw up with git because we can
revert any changes made.
Ask on or off list for any help with managing or working in it.
>> There is an existing Debian style guide somewhere that I cannot find, but I also
>> think it may need updating and at this point with our team expanding we really
>> need to nail down how we present what we are saying overall.
>
> There's a page of guidelines at
> https://wiki.debian.org/ProjectNews/Guidelines
> with a link to the MHRA Style Guide - at least to justify the use of a
> standard '%d %b %Y' date format.
Thank you! I knew we had had one in place somewhere. That document can be
updated or superseded from this overall work. More so as we have shifted from
the newsletter type of presentation towards direct announcements, blogs, and
social media postings, though nonetheless this work would be critical in how we
write those announcements and pieces.
My only plan/concern for this work is to figure out how to incorporate our
'avoidable publishing errors miniature document'[1]. I think most likely for
visibility to keep it in the new repository's top level, but up to you where to
place it.
>> Thoughts (and acceptance :)) ?
>
> I'd be happy to try to help.
Thank you!!!!!
> (Collaborators may benefit from knowing that in recent years I've
> switched from keeping "extreme owl-mode" hours to "extreme
> lark-mode"...)
4AM EST is still my bedtime so I'll still see you. :)
>> Also should you elect to become a DD I will be the first to advocate for you,
>> your impact on the project is well documented and it would be an honor.
>
> I suffer quite enough Impostor Syndrome just acting as if I'm an
> authority on semicolons!
What; if so can you, mean, here?
[1]
https://salsa.debian.org/publicity-team/todo/-/blob/main/Documentation/gotchas.md
--
-
Be well,
Donald Norwood
Debian Press and Publicity
--
-
⢀⣴⠾⠻⢶⣦⠀
⣾⠁⢠⠒⠀⣿⡁ Donald Norwood
⢿⡄⠘⠷⠚⠋⠀ B7A1 5F45 5B28 7F38 4174
⠈⠳⣄⠀⠀⠀⠀ D5E9 E5EC 4AC9 BD62 7B05
Reply to: