From fcaad61844151509fab7a8dbb023bc46fb454ef9 Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Sep 10 2019 12:52:30 +0000 Subject: update other content for the new workflow --- diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 79b2b66..b130d8f 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,20 +1,16 @@ * xref:workflow.adoc[Editorial Workflow] ** xref:workflow-article-proposal.adoc[1 Article Proposal] ** xref:workflow-clarification.adoc[2 Clarification] -** xref:workflow-writing.adoc[3 Writing] +** xref:writing-an-article.adoc[3 Writing] ** xref:workflow-review.adoc[4 Review] ** xref:workflow-edit-image.adoc[5 Edit & Image] ** xref:workflow-publishing.adoc[6 Publishing] +* xref:writing-a-pitch.adoc[Proposing Articles] +* xref:contributing.adoc[Contributing as a Writer] +** xref:getting-access.adoc[Getting Access] +** xref:tips-for-writers.adoc[Tips for Writers] +* xref:editorial.adoc[Contributing as an Editor] +** xref:editorial-meetings.adoc[Editorial Meetings] +** xref:approving-comments.adoc[Approving Comments] +** xref:creating-an-image.adoc[Creating a Featured Image] - - - -* xref:contributing.adoc[Contributing content] -** xref:getting-access.adoc[Getting access] -** xref:writing-a-pitch.adoc[Writing a pitch] -** xref:writing-an-article.adoc[Writing an article] -** xref:creating-an-image.adoc[Creating a featured image] -* xref:tips-for-writers.adoc[Tips for writers] -* xref:editorial.adoc[Contributing as an editor] -** xref:editorial-meetings.adoc[Editorial meetings] -** xref:approving-comments.adoc[Approving comments] diff --git a/modules/ROOT/pages/contributing.adoc b/modules/ROOT/pages/contributing.adoc index 04f6642..51c3e1b 100644 --- a/modules/ROOT/pages/contributing.adoc +++ b/modules/ROOT/pages/contributing.adoc @@ -1,18 +1,7 @@ -= Contributing content to the Fedora Magazine += Contributing to the Fedora Magazine as a writer -Fedora Magazine welcomes contributions of content relevant to Fedora Users. +Anyone with good writing skills is welcome to write an article for the Fedora Magazine! -Before the first contribution: +See the xref:writing-an-article.adoc[Writing page] to learn how to do that. -1. xref:getting-access.adoc[**Get access**:] You need to have access to our Wordpress in order to contribute. - -Writers' steps: - -2. xref:writing-a-pitch.adoc[**Write a pitch**:] Propose your idea to the editorial board and get it accepted. -3. xref:writing-an-article.adoc[**Write the article**:] Write your article following the recommendations and let the editorial board know when you're ready. - -Editors' steps: - -4. **Edit the article**: An editor makes sure the article reads well, checks facts, and corrects typos. -5. xref:creating-an-image.adoc[**Create an image**:] Each article gets a cover image before its published. -6. **Schedule the article**: Finally, the article is scheduled for publishing! +If this is your first contribution, you will need to xref:getting-access.adoc[get access] first. \ No newline at end of file diff --git a/modules/ROOT/pages/workflow-writing.adoc b/modules/ROOT/pages/workflow-writing.adoc deleted file mode 100644 index bdc2584..0000000 --- a/modules/ROOT/pages/workflow-writing.adoc +++ /dev/null @@ -1,23 +0,0 @@ -= Writing Articles - -image::fedora-magazine-workflow-3.jpg[,100%,] - -Anyone with good writing skills is welcome to write an article for the Fedora Magazine! - -Writing an article requires write access to our https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban[Taiga board] (so you can indicate progress) and optionally to our https://fedoramagazine.org/admin[Wordpress instance] (if you choose to write it there). Read the [Becoming a Writer] page for more information. - -== Writing an article - -**Choose** any article you like in the __Article Spec__ column in the https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban[Kanban board in Fedora Magazine Taiga]. - -**Assign** the card you've chosen to yourself by opening the card and clicking on __Assign to myself__ on the right hand side. - -**Move it to __In Progress__** by simply dragging the card to the appropriate column. - -**Write** your article either in Wordpress (create a new article there) or anywhere you prefer. Read the xref:tips-for-writers.adoc[Tips for Writers] page for specific guidance about our preferred writing style. - -**Move it to __Review__** when done with writing. Please include a link to Wordpress or to the text in the card before moving it to the __Review__ column so the Editors can access it. - -And that's it! - -Please note that in some cases the editors might require a change in your article. In that case, you'll receive feedback in the card, and it'll be moved back to the __In Progress__ column. In that case, please make the requested change and move it back to __Review__ when you're done. \ No newline at end of file diff --git a/modules/ROOT/pages/workflow.adoc b/modules/ROOT/pages/workflow.adoc index 699bcd5..4b8f4d5 100644 --- a/modules/ROOT/pages/workflow.adoc +++ b/modules/ROOT/pages/workflow.adoc @@ -2,3 +2,19 @@ image::fedora-magazine-workflow.jpg[,100%,] +Content on the Fedora Magazine is created using a 6-step workflow: + +1. xref:workflow-article-proposal.adoc[Article Proposal] by Anyone +2. xref:workflow-clarification.adoc[Clarification] by Editors +3. xref:writing-an-article.adoc[Writing] by a Writer +4. xref:workflow-review.adoc[Review] by Editors +5. xref:workflow-edit-image.adoc[Edit & Image] by Editors +6. xref:workflow-publishing.adoc[Publishing] by Editors + +During that process, the article goes through 7 states: __idea__, __article spec__, __in progress__, __review__, __to edit__, __queued__, and __published__. Each step in the workflow has its own page in this documentation that provides guidance. + +== Tracking + +Proposals in the **__idea__** state are represented as an issue in the https://teams.fedoraproject.org/project/asamalik-fedora-magazine/issues[Issues section of the Fedora Magazine Taiga]. + +Articles in **all other states** are represented as cards in the https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban[Kanban section of the Fedora Magazine Taiga], each state having its own column on the board. \ No newline at end of file diff --git a/modules/ROOT/pages/writing-a-pitch.adoc b/modules/ROOT/pages/writing-a-pitch.adoc index ea3cd0e..dae2272 100644 --- a/modules/ROOT/pages/writing-a-pitch.adoc +++ b/modules/ROOT/pages/writing-a-pitch.adoc @@ -1,26 +1,5 @@ -= Writing a pitch for the Fedora Magazine += Proposing Articles for the Fedora Magazine -== What is a pitch? +Anyone is welcome to propose an article to the https://fedoramagazine.org[Fedora Magazine]. -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. - -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 - -__The following article serves as an example outline for proposing a new pitch for the Fedora Magazine. This example was used for the https://fedoramagazine.org/never-leave-irc-znc/[Never leave IRC again with ZNC] article.__ - -**Summary**: Describe how to set up an IRC bouncer using ZNC - -**Description**: The purpose of this article would be to describe what an IRC bouncer is and how someone can set up their own ZNC instance to connect to IRC networks and remain persistently connected to channels. The article would aim to educate the user about two things: what and how. Since IRC is a major communication platform for Fedora (and most free and open-source project communities), this article would ideally promote using IRC as well. The flow of the article would be as follows: - -* 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 +See the xref:workflow-article-proposal.adoc[Article Proposal] page for how to do that. \ No newline at end of file diff --git a/modules/ROOT/pages/writing-an-article.adoc b/modules/ROOT/pages/writing-an-article.adoc index e3dd007..bd6c991 100644 --- a/modules/ROOT/pages/writing-an-article.adoc +++ b/modules/ROOT/pages/writing-an-article.adoc @@ -1,8 +1,33 @@ -= Writing an article for the Fedora Magazine += Writing Articles -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. +image::fedora-magazine-workflow-3.jpg[,100%,] + +Anyone with good writing skills is welcome to write an article for the Fedora Magazine! + +Writing an article requires write access to our https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban[Taiga board] (so you can indicate progress) and optionally to our https://fedoramagazine.org/admin[Wordpress instance] (if you choose to write it there). Read the [Becoming a Writer] page for more information. + +== Writing an article + +=== 1. Choose what to write + +**Choose** any article you like in the __Article Spec__ column in the https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban[Kanban board in Fedora Magazine Taiga]. + +**Assign** the card you've chosen to yourself by opening the card and clicking on __Assign to myself__ on the right hand side. + +**Move it to __In Progress__** by simply dragging the card to the appropriate column. + +=== 2. Write it + +**Write** your article either in Wordpress (create a new article there) or anywhere you prefer. Read the xref:tips-for-writers.adoc[Tips for Writers] page for specific guidance about our preferred writing style. + +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. +=== 3. Mark it as done + +**Move it to __Review__** when done with writing. Please include a link to Wordpress or to the text in the card before moving it to the __Review__ column so the Editors can access it. + +And that's it! +Please note that in some cases the editors might require a change in your article. In that case, you'll receive feedback in the card, and it'll be moved back to the __In Progress__ column. In that case, please make the requested change and move it back to __Review__ when you're done. \ No newline at end of file