During #3060700: [HU] Translation update based on #3028513 I observed that in the recently added source/en/extend-git.txt there's no [role="summary"] part coming after the file title as usually does. As @jhodgdon confirmed via Slack it's a mistake, so here's a possible sentence provided to fill the gap.

CommentFileSizeAuthor
#3 3060710-fix-up-summaries.txt16.42 KBjhodgdon
3060710-missing-summary-extend-git-1.patch425 bytesbaluertl

Comments

Balu Ertl created an issue. See original summary.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Assigned: Unassigned » jhodgdon
Status: Needs review » Needs work
Issue tags: +Translation updates needed

I verified this is the only file that does not currently contain a summary in the English source. The proposed sentence for the extend-git topic looks reasonable, needs a little editing... not sure we want to use the word "popular" in there either?

Also... The reason it was left out by mistake was probably because the templates for new topics do not currently have the summary section in them. So, we should fix that too. We have the templates as individual files in the templates directory, and also in the guidelines/templates.txt file.

Anyway. I can take care of editing that line and adding to the templates. Thanks!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Title: Supply missing summary section in extend-git » Supply missing summary section in extend-git and regularize summaries
Status: Needs work » Needs review
StatusFileSize
new 3060710-fix-up-summaries.txt16.42 KB

Here's a new patch, with a slightly edited summary for the one file, and updates to the templates so this hopefully will not happen again. I also included notes in the templates about our standards that we adopted in #2775689: Create summaries for topics in the User Guide when we first added summaries. And I copied the templates that were in the guidelines/templates.txt files to the actual template files in the templates folder -- they weren't quite identical.

I also noticed that some of our summaries have newlines in them if they go over 80 characters, and some don't. It looks like either works with our scripts and/or drupal.org... We have a guideline that says all text should be wrapped into 80-character lines. So, I fixed that in a few files.

baluertl’s picture

baluertl
he/him
Primary language Hungarian
Location Budapest 🇪🇺
commented
Status: Needs review » Needs work

I like the idea of consistency in line breaks above 80 chars.

My only observation is that once we suggest that the summary lines should start with "Overview of":

+=== Concept: ...
+
+// The next few lines are a summary of what the topic covers. Should start with
+// "Overview of".
+[role=summary]
+Overview of foo. No more than 140 characters. Wrap text at 80 characters if it
+goes over.
 
 //

Then later on we do not follow our rule:

+=== Verbing a Noun
+
+// The next few lines are a summary of what the topic covers. Should start with
+// "How to [verb]".
+[role=summary]
+How to verb a noun. No more than 140 characters. Wrap text at 80 characters if
+it goes over.
 
 //

So if I understand correctly, this example sentence should read:

Overview of how to verb a noun. No more than 140 characters. Wrap text at 80 characters if it goes over.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs work » Needs review

No, actually those are two different templates for two different types of topics. The "concept" topics summary should start with "Overview of", and topic title is like "Concept: something". The "task" topics summary should start with "How to verb a noun" and topic title is like "Verbing a noun". We list both templates, one after the other, in the Templates section of the guidelines, which is why both of them are shown in that same file in the patch:
https://www.drupal.org/docs/user_guide_guidelines/templates.html

baluertl’s picture

baluertl
he/him
Primary language Hungarian
Location Budapest 🇪🇺
commented
Status: Needs review » Reviewed & tested by the community

Oh, then I overlooked their difference, sorry. Then RTBC'ed of course.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Thanks again! Committed, and email going out shortly to the translation group.

  • jhodgdon committed f102e23 on 8.x-7.x 
    Issue #3060711 by Balu Ertl, jhodgdon: Supply missing summary section in...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.