From bfcaba3d62d9b6b6d2f268c1a4dd9d2f84fe7452 Mon Sep 17 00:00:00 2001 From: Paul W. Frields Date: Jul 02 2019 18:19:48 +0000 Subject: [PATCH 1/2] Make the pitch writing tips a little more readable --- diff --git a/modules/ROOT/pages/writing-a-pitch.adoc b/modules/ROOT/pages/writing-a-pitch.adoc index d0c6d36..ea3cd0e 100644 --- a/modules/ROOT/pages/writing-a-pitch.adoc +++ b/modules/ROOT/pages/writing-a-pitch.adoc @@ -2,13 +2,15 @@ == What is a pitch? -A pitch is the first step for proposing a new article for the Fedora Magazine. If you are looking at getting started with the Magazine and are not yet familiar with what a pitch is, read how to begin contributing to the Magazine. Anyone who is ready to write a pitch should try to use the following format when writing their pitch. Using this format will ensure a speedy and easy review, and in the event that you do not plan to write the article, it will make it easier for a writer to hit key points. +A pitch is the first step to propose a new article for the Fedora Magazine. If you want to get started with the Magazine and are don't know what a pitch is, read xref:contributing.adoc[how to begin contributing to the Magazine]. + +If you're ready to write a pitch, try to use the following format. This format can help with a speedy and easy review. Furthermore, in the event you aren't able to write the article, it makes it easier for a writer to hit key points. == Writing a pitch -Create a new post with Pitch status in the Fedora Magazine WordPress interface. Pitch is the default status for a new post. In your newly-created post, write a brief outline of your post, what it will contain, and the target audience. The Fedora Magazine’s primary audience is Fedora users — including sysadmins and developers too. But in some cases we have content directed at both Fedora users and contributors. +Create a new post with __Pitch__ status in the Fedora Magazine WordPress interface. __Pitch__ is the default status for a new post. In your newly-created post, write a brief outline of your post, what it will contain, and the target audience. The Fedora Magazine’s primary audience is Fedora users — including sysadmins and developers too. But in some cases we have content directed at both Fedora users and contributors. -Once you’re happy with your pitch, email the Fedora Magazine mailing list with a preview link to your pitch. The Magazine editors will review your idea and give you some feedback, and hopefully approve your idea for an article. We review pitches so you don’t waste time on writing a full article that turns out not to fit the Magazine in the end. **Don’t write the whole article** before this step. Let us help you focus it well for best results! +Once you’re happy with your pitch, email the mailto:magazine@lists.fedoraproject.org[Fedora Magazine mailing list] with a preview link to your pitch. The Magazine editors will review your idea and give you some feedback, and hopefully approve your idea for an article. We review pitches so you don’t waste time on writing a full article that turns out not to fit the Magazine in the end. **Don’t write the whole article** before this step. Let us help you focus it well for best results! == Example Pitch @@ -21,4 +23,4 @@ __The following article serves as an example outline for proposing a new pitch f * What is an IRC bouncer / proxy and how does it work? * Introducing ZNC * Download, installing, and configuring ZNC on a Fedora machine -* Configuring IRC client to use your ZNC bouncer \ No newline at end of file +* Configuring IRC client to use your ZNC bouncer From 5ac756190e2afe14630d77f551f40d1459b89e5c Mon Sep 17 00:00:00 2001 From: Paul W. Frields Date: Jul 02 2019 18:31:33 +0000 Subject: [PATCH 2/2] Gratuitous markup fixes --- diff --git a/modules/ROOT/pages/tips-for-writers.adoc b/modules/ROOT/pages/tips-for-writers.adoc index 095ae5e..7ca4169 100644 --- a/modules/ROOT/pages/tips-for-writers.adoc +++ b/modules/ROOT/pages/tips-for-writers.adoc @@ -6,7 +6,7 @@ These tips will help your article sail through editing. Be kind to your editor(s Primary rule: don’t get too fancy. Legibility is important. -1. **Don’t mix monospace fonts with proportional fonts in a sentence.** Use italics for the special text. For instance, don’t write dnf install foo in the middle of a sentence, write dnf install foo. +1. **Don’t mix monospace fonts with proportional fonts in a sentence.** Use italics for the special text. For instance, don’t write dnf install foo in the middle of a sentence, write __dnf install foo__. 2. **Use italics for system objects you mention in a sentence:** ** GUI or CLI elements like button text or menu entries ** other prompts the reader must find on the screen @@ -67,4 +67,4 @@ These tips are about things to do — and avoid — in what you tell users to do == Other hints -Got an idea for better writing? Discuss with the editors on IRC Freenode at the #fedora-magazine channel. \ No newline at end of file +Got an idea for better writing? Discuss with the editors on IRC Freenode at the #fedora-magazine channel. diff --git a/modules/ROOT/pages/writing-an-article.adoc b/modules/ROOT/pages/writing-an-article.adoc index 50a4235..e3dd007 100644 --- a/modules/ROOT/pages/writing-an-article.adoc +++ b/modules/ROOT/pages/writing-an-article.adoc @@ -1,8 +1,8 @@ = Writing an article for the Fedora Magazine -Now that you have an approved pitch, you can **write your article**. https://fedoramagazine.org/how-to-structure-your-article/[Here’s a template you can use] to structure your article well, and make it as useful as possible to readers. Make sure you set the article status from Pitch to Draft once you receive approval. +Now that you have an approved pitch, you can **write your article**. https://fedoramagazine.org/how-to-structure-your-article/[Here’s a template you can use] to structure your article well, and make it as useful as possible to readers. Make sure you set the article status from __Pitch__ to __Draft__ once you receive approval. As you write your draft, try to understand and follow the xref:tips-for-writers.adoc[style, grammar, and SEO guidelines] for the Magazine. Don’t skip this step! The guidelines tell you how to use markup, write better sentences, and get your article ranked well in search engines. Also, if you write a better article, the editors are more likely to publish it sooner. -When you’re completely finished, **submit the article for review**. Set your article’s Status as Pending review in the Publish box at top right, and email the mailing list. The editors will review your draft, and provide feedback to you via the mailing list. Please note that once you mark your article as Pending review the editors assume you believe the article is ready to publish. +When you’re completely finished, **submit the article for review**. Set your article’s __Status__ as __Pending review__ in the __Publish__ box at top right, and email the mailing list. The editors will review your draft, and provide feedback to you via the mailing list. Please note that once you mark your article as __Pending review__ the editors assume you believe the article is ready to publish.