From 56264722193bdebc384e9fcc0381548e70b225bf Mon Sep 17 00:00:00 2001 From: Paul W. Frields Date: Jun 24 2020 15:25:45 +0000 Subject: [PATCH 1/4] First stab at a checklist --- diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 7014ccc..ef0c834 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -12,6 +12,7 @@ ** xref:tips-for-writers.adoc[Tips for Writers] * xref:editorial.adoc[Contributing as an Editor] ** xref:editor-of-the-week.adoc[Editor of the Week] +** xref:editorial-checklist.adoc[Editorial Checklist] ** xref:editorial-meetings.adoc[Editorial Meetings] ** xref:approving-comments.adoc[Approving Comments] ** xref:creating-an-image.adoc[Creating a Featured Image] diff --git a/modules/ROOT/pages/editorial-checklist.adoc b/modules/ROOT/pages/editorial-checklist.adoc new file mode 100644 index 0000000..b56fe77 --- /dev/null +++ b/modules/ROOT/pages/editorial-checklist.adoc @@ -0,0 +1,28 @@ += Checklist for editors + +Editors should follow this checklist to help articles meet standards before being published. + +== Formatting + +* [ ] After the introductory paragraph, include the __--- Read More ---__ element. This causes RSS readers to visit the site to view the article. +* [ ] Remove any monospace text mixed into paragraphs, such as elements. Either convert these to italics, or move them into Preformatted blocks in WordPress, fixing surrounding text as necessary. + +== Style + +* [ ] Check the article for adherence to the xref:tips-for-writers.adoc[guidelines and tips for writers]. **This may take a while, so leave yourself sufficient time for this step.** +* [ ] Set all article and section titles to sentence case. + +== Usage + +* [ ] Eliminate use of __I, we, us,__ and __our__ in the article, rewriting where necessary. Articles should not refer to the author if avoidable. + +== SEO and metadata + +* [ ] Set an appropriate https://yoast.com/focus-keyword/[focus keyword]. +* [ ] Address any article shortcomings that affect readability. (It may not be possible to turn the readability score to "green" in all cases.) +* [ ] Categorize the article. The default "Fedora Project community" category should rarely be used. +* [ ] Add tags for article subject matter. Use as many as possible. + +== Publishing + +* [ ] Schedule the article to publish at 08:00 UTC (the Magazine default timezone) on the selected day, unless decided otherwise. diff --git a/modules/ROOT/pages/editorial.adoc b/modules/ROOT/pages/editorial.adoc index ea9a4fe..e2f8718 100644 --- a/modules/ROOT/pages/editorial.adoc +++ b/modules/ROOT/pages/editorial.adoc @@ -5,6 +5,8 @@ include::partial$workflow-change-banner.adoc[] The duties of an editor are much like any blog owner. Occasionally editors also xref:contributing.adoc[contribute content] when the queue or backlog of content is running a little low. Editors take turns serving as the xref:editor-of-the-week.adoc[Editor of the Week]. +Editors follow an xref:editorial-checklist.adoc[editorial checklist] to help articles meet a quality and content bar, and to ensure they're well searchable. + Editors hold a xref:editorial-meetings.adoc[weekly editorial meeting] to discuss and approve content, help guide authors, and figure out ways to improve the Magazine and further its mission. The best way to become an editor is to join the weekly meeting, and demonstrate your ability to contribute consistently. Like most blogs and news sites, the Magazine receives feedback and comments from the public. Editors xref:approving-comments.adoc[moderate comments based on common guidelines]. They ensure that discussions stay constructive and discourage trolls and other bad actors. From 1a1cd5baa4738c803b19b52b3810b905d9339143 Mon Sep 17 00:00:00 2001 From: Paul W. Frields Date: Jun 26 2020 20:11:09 +0000 Subject: [PATCH 2/4] Note on tag creation --- diff --git a/modules/ROOT/pages/editorial-checklist.adoc b/modules/ROOT/pages/editorial-checklist.adoc index b56fe77..b864727 100644 --- a/modules/ROOT/pages/editorial-checklist.adoc +++ b/modules/ROOT/pages/editorial-checklist.adoc @@ -21,7 +21,7 @@ Editors should follow this checklist to help articles meet standards before bein * [ ] Set an appropriate https://yoast.com/focus-keyword/[focus keyword]. * [ ] Address any article shortcomings that affect readability. (It may not be possible to turn the readability score to "green" in all cases.) * [ ] Categorize the article. The default "Fedora Project community" category should rarely be used. -* [ ] Add tags for article subject matter. Use as many as possible. +* [ ] Add tags for article subject matter. Use as many as possible. As you type a new tag, observe the popup help. Try to choose relevant tags, and avoid creating new ones with trivial differences. == Publishing From e140555fae5a78b73950e086191fd8fa1a69881b Mon Sep 17 00:00:00 2001 From: Paul W. Frields Date: Jun 26 2020 20:23:25 +0000 Subject: [PATCH 3/4] Add section on featured images to editorial checklist --- diff --git a/modules/ROOT/pages/editorial-checklist.adoc b/modules/ROOT/pages/editorial-checklist.adoc index b864727..1767d35 100644 --- a/modules/ROOT/pages/editorial-checklist.adoc +++ b/modules/ROOT/pages/editorial-checklist.adoc @@ -23,6 +23,11 @@ Editors should follow this checklist to help articles meet standards before bein * [ ] Categorize the article. The default "Fedora Project community" category should rarely be used. * [ ] Add tags for article subject matter. Use as many as possible. As you type a new tag, observe the popup help. Try to choose relevant tags, and avoid creating new ones with trivial differences. +== Featured images + +* [ ] Make sure the article has an appropriate xref:creating-an-image.adoc[featured image]. This is **not** the same as an image in the article text itself, and should not appear there. Use the Featured Image box in the document details in WordPress. +* [ ] Featured images should be included or submitted to the https://pagure.io/fedoramagazine-images[featured images repo on Pagure]. Refer to the xref:creating-an-image.adoc[documentation on featured images] for more information. + == Publishing * [ ] Schedule the article to publish at 08:00 UTC (the Magazine default timezone) on the selected day, unless decided otherwise. From 0338007e274ba9c4ecae13f3bfcca4b764cf0074 Mon Sep 17 00:00:00 2001 From: Paul W. Frields Date: Jun 26 2020 20:26:07 +0000 Subject: [PATCH 4/4] Editorial checklist: add tip on Excerpt --- diff --git a/modules/ROOT/pages/editorial-checklist.adoc b/modules/ROOT/pages/editorial-checklist.adoc index 1767d35..d868480 100644 --- a/modules/ROOT/pages/editorial-checklist.adoc +++ b/modules/ROOT/pages/editorial-checklist.adoc @@ -22,6 +22,7 @@ Editors should follow this checklist to help articles meet standards before bein * [ ] Address any article shortcomings that affect readability. (It may not be possible to turn the readability score to "green" in all cases.) * [ ] Categorize the article. The default "Fedora Project community" category should rarely be used. * [ ] Add tags for article subject matter. Use as many as possible. As you type a new tag, observe the popup help. Try to choose relevant tags, and avoid creating new ones with trivial differences. +* [ ] Add an Excerpt in the document details in WordPress. This shows up in the https://en.wikipedia.org/wiki/RSS[RSS] feed shown in https://start.fedoraproject.org[start page in Fedora's web browser defaults]. == Featured images