magazine/fedora-magazine
1
1
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions

Reconciled process with Pagure. Added new Pagure tech page

Browse source
This commit is contained in:
Richard England 2021-12-15 13:32:15 -08:00
commit 3f285612a9
13 changed files with 130 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/ROOT/nav.adoc
View file

@ -18,5 +18,5 @@
** xref:adding-a-writer.adoc[Adding a Writer]
* xref:technical.adoc[Technical Notes and Processes]
** xref:technical-theme.adoc[Maintaining the Theme]
** xref:technical-taiga.adoc[Taiga Operations]
** xref:technical-pagure.adoc[Pagure Operations]
** xref:technical-wordpress.adoc[WordPress Operations]

3
modules/ROOT/pages/contributing.adoc
View file

@ -5,10 +5,11 @@ include::partial$workflow-change-banner.adoc[]
Fedora Magazine welcomes new writers to contribute their skill by writing an article or two... or five! There are several ways you can find something to write about:
* We have a list of specific topics to start with — so you don't need to come up with new ideas to write.
See the __IDEAS__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Fedora Magazine Kanban board].
* You can also xref:writing-a-pitch.adoc[propose an article] if you have your own idea.
Either way, your writing goes out to tens of thousands of readers that visit Fedora Magazine every week!
If this is your first contribution, you will need to xref:getting-access.adoc[get access] first.
**Need help on how to write better? See the xref:writing-an-article.adoc[Editorial Workflow - Writing] page for guidance.**
**Need help on how to write better? See the xref:writing-an-article.adoc[Editorial Workflow - Writing] page for guidance.**

24
modules/ROOT/pages/editorial-meetings.adoc
View file

@ -55,11 +55,11 @@ First, let's look back at the previous week in terms of pageviews. This data can
#topic 2/ In progress followup
#info Looking at the 'in progress' column, is there something that's been finished? Anything to follow up on with its author?
#link Board: https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban
#link Board: https://pagure.io/fedora-magazine-newsroom/boards/articles
Review anything that's in progress. If an article is stuck in progress for a long time without an update, contact the author and ask them if they still plan to finish their work.
Anything that's already finished can be moved to the Finished column.
Anything that's already finished and commented so by the author can be moved to the "REVIEW" column.
You may also want to check the QA calendar for upcoming test days so that we can expect a new post submission.
These tend to come in with very short notice, so the Editor of the Week should use their best judgment in deciding when to publish.
@ -78,17 +78,19 @@ This is generally only important a few weeks before the Beta and Final releases,
=== 3/ Finished articles to review
#topic 3/ Finished articles to review
#info Looking at the 'review' column, let's decide which articles are good to go. Move each either to the 'to edit' (finished) or to the 'in progress' (needs more work) and provide feedback.
#link Board: https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban
#info Looking at the 'REVIEW' column, let's decide which articles are good to go. Move each either to the 'TO-EDIT' or to the 'IN-PROGRESS' (needs more work) and provide feedback.
#link Board: https://pagure.io/fedora-magazine-newsroom/boards/articles
Authors mark their articles as finished by moving them to this column. Review the articles and ehtier move them to the To Edit column, or in case they need some additional work, ask the author in the card about it and move it back the In Progress.
Authors mark their articles as finished by adding a comment announcing that fact. Review the articles
and ethier move them to the 'TO-EDIT' column, or in case they need some additional work, ask the
author in the card about it and move it back to 'IN-PROGRESS'.
=== 4/ Articles to edit
#topic 4/ Articles to edit
#info Looking at the 'to edit' column, assign an editor and a cover image creator.
#link Board: https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban
#info Looking at the 'TO-EDIT' column, assign an editor and a cover image creator.
#link Board: https://pagure.io/fedora-magazine-newsroom/boards/articles
Assign an editor and a cover image designer to each article so it can be moved forward.
@ -96,9 +98,9 @@ Assign an editor and a cover image designer to each article so it can be moved f
=== 5/ Publishing schedule
#topic 5/ Publishing schedule
#info Looking at the 'to edit' column, decide the publishing schedule for the next week.
#info If there is not enough content, we might also need to look at the 'in progress' or even the 'article spec' columns come up with additional content.
#link Board: https://teams.fedoraproject.org/project/asamalik-fedora-magazine/kanban
#info Looking at the 'TO-EDIT' column, decide the publishing schedule for the next week.
#info If there is not enough content, we might also need to look at the 'IN-PROGRESS' or even the 'IDEAS' columns to come up with additional content.
#link Board: https://pagure.io/fedora-magazine-newsroom/boards/articles
Setting the publishing schedule for the upcoming week period is one of the main goals of this meeting.
@ -115,7 +117,7 @@ This can be generated by a script. Run:
$ podman run --rm -it asamalik/magazine-schedule
The script consumes data from the individual cards, so please make sure the date, and the assignees are set properly.
The script consumes data from the individual cards, so please make sure the date, and the editorrial assignees are set properly.
Find more information about the script in the https://github.com/asamalik/magazine-schedule[asamalik/magazine-schedule github repository].

5
modules/ROOT/pages/getting-access.adoc
View file

@ -12,11 +12,12 @@ https://fedoramagazine.org/wp-admin/[Sign in to the Fedora Magazine WordPress da
**3. Sign in to the Kanban board**:
https://pagure.io/fedora-magazine-newsroom/boards/articles[Sign in to the Pagure Kanban board] using your Fedora Account.
This does NOT grant write access. It is so the account is known to the system, cards can be assigned to you, and you can be manually granted privileges by an administrator after step 4.
This does NOT grant write access. It is so the account is known to the system and cards can be assigned to you.
**4. Join the Magazine forum and introduce yourself**:
Join the discussion in the https://discussion.fedoraproject.org/c/project/magazine[Fedora Magazine Discourse forum].
This is where we discuss everything to do with the Fedora Magazine.
Introduce yourself and tell us that you wish to contribute to the Fedora Magazine.
A Fedora Magazine editor will then grant you access to create and edit posts, and submit them for review.
The Fedora Magazine editors monitor this Discourse forum and will be able to help you and answer any Fedora
Magazine related questions.

2
modules/ROOT/pages/index.adoc
View file

@ -2,7 +2,7 @@
include::partial$workflow-change-banner.adoc[]
http://fedoramagazine.org[Fedora Magazine] is a WordPress-based site which delivers all the news of the Fedora Community. (It replaced the older publication, Fedora Weekly News.)
http://fedoramagazine.org[Fedora Magazine] is a __WordPress-based__ site which delivers all the news of the Fedora Community. (It replaced the older publication, Fedora Weekly News.)
== What does the Magazine publish?

76
modules/ROOT/pages/technical-pagure.adoc Normal file
View file

@ -0,0 +1,76 @@
= Pagure Operations
== Adding a new user
If an author has not accessed Pagure before, they must login
with their https://accounts.fedoraproject.org/#register[FAS account].
The https://pagure.io/fedora-magazine-newsroom/boards/articles[Fedora Magazine site is here].
They will need to select the *Log in* button in the upper right corner of the page.
This will allow the editors to assign cards to them.
There is nothing more to do administratively.
== Creating a new card (user story)
When a proposal is approved, follow these steps.
. From the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban page],
select the *New issues* button (upper right corner).
. Enter the title of the article in the top text box
. Enter details of the proposal in the bottom text box. __Include a link to the proposal
discussion__, where appropriate
. If an author has been identified and has logged in to Pagure, select the *Assignee*
text box in the METADATA column at the right and locate their name
. Select *Create Issue* at the bottom of the page
When the new issue has been created, continue with these steps.
. Select the "pencil icon" at the top of the METADATA column at the right
. In the *Tags* selection field select "article" and "needs-image"
. Select *Update* at the bottom of the METADATA column.
The new card should appear at the bottom of the Kanban *IDEAS* column. If it does
not you can add it by selecting the *+* at the top of the *IDEAS* column and entering the
new "Issue" number.
If you do not know the "Issue" number, select *Issues* at the top of the Kanban
page and locate it in the list of issues.
== Changing the state of the cards
Authors must indicate, in the comments of each card, when they feel the state needs
to change from __IDEAS__ to __IN-PROGRESS__ to __REVIEW__.
The editors will change the state by "dragging" the cards on the Kanban page as needed.
The editors will determine when the articles are ready to move to __TO EDIT__, drag
the cards on the Kanban board, and add a comment to that effect to inform the author.
== Adding editors
Editors should be admins on the board. You must be an Administrator to add an editor.
Use the following steps.
. On the Kanban page, select the *Settings* tab at the top of the Pagure page
. Select *Users & Groups* from the list in the left column on this page
. Select *add user*
. Type in the FAS "Username" in the first text field, to search. Note that the user must
have logged into Pagure prior to this operation for the name to be available
. Set the next field (a selection field) to *Admin*
. Select *Add*
== Removing editors
You must be an Administrator to remove an editor.
Use the following steps.
. On the Kanban page, select the *Settings* tab at the top of the Pagure page.
. Select *Users & Groups* from the list in the left column on this page.
. Locate the name of the admin to remove and select the red "trash can" icon at the right
of the name
NOTE: Update the https://pagure.io/group/fedora-magazine[Pagure group] membership as well
so that the docs and images repos have the correct permissions.

2
modules/ROOT/pages/technical.adoc
View file

@ -2,4 +2,6 @@
The Magazine site itself is simply a https://wordpress.org[WordPress site]. Like any website, it may require maintenance from time to time.
Pagure is the system used to track the status of cards ("Issues") for the articles.
One system that sometimes requires changes or fixes is the https://pagure.io/fedoramagazine-theme[Magazine theme]. There is a process to xref:technical-theme.adoc[modify, test, and deploy theme changes].

2
modules/ROOT/pages/workflow-article-proposal.adoc
View file

@ -12,7 +12,7 @@ Proposals can be ideas or specific pitches (an example is below). Proposing an a
Join the community in the https://discussion.fedoraproject.org/c/project/magazine[Fedora Magazine Discourse forum] and submit your idea as a new topic.
TIP: If this is your first proposal, and you also plan to write an article, you can help us speed the process up by logging into our https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure] — Select the __Log In__ button to log in with your Fedora Account. That is required before an article can be assign to you.
TIP: If this is your first proposal, and you also plan to write an article, you can help us speed the process up by logging into our https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure] — Select the __Log In__ button to log in with your Fedora Account. That is required before an article can be assigned to you.
== A specific pitch example

6
modules/ROOT/pages/workflow-clarification.adoc
View file

@ -16,11 +16,9 @@ Opinions and additional relevant information is welcome from anyone.
If an editor is happy with the proposal, all they need to do is to reply "+1". Proposals with two or more +1's are approved.
When a proposal is approved, a new card is created in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure], in the __IDEAS__ column.
When a proposal is approved, a new card is created by an editor in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure], in the __IDEAS__ column.
When the card is created, add the __Assignee__, under the METADATA column. This ensures the author is emailed when the card status changes.
Select __Create Issue__ and when the new card has been created, select the "pencil" icon in the METADATA column and add the *Tags* __article__ and __needs-image__. Do not add the tags before the new card has been created.
When the card is created, and the author is known, the owner is assigned in the __Assignee__ field, under the METADATA column. This ensures the author is emailed when the card status changes. This operation is performed by the editor.
This card now represents a specific article and goes through all the other steps of the workflow.

21
modules/ROOT/pages/workflow-edit-image.adoc
View file

@ -10,25 +10,26 @@ Members of the Editorial Board provide both of those.
== Editing
Articles that require editing are in the __TO-EDIT__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure].
Articles that require editing are in the __TO-EDIT__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board of the Fedora Magazine Pagure].
Since multiple people will be potentially completing this step, they need to coordinate in comments in the card.
Since multiple people will be potentially completing this step, they need to coordinate with comments on the card.
**Edit** the article for potential grammatical and spelling errors.
The editors will **Edit** the article for potential grammatical and spelling errors.
When done, they indicate that in the comments.
When done, indicate that in the comments.
If the cover image has also been done indicate that in the comments as well and remove the __needs-image__ tag by selecting the "pencil" icon in the METADATA colum and removing the tag.
If the cover image has also been done that will be indicated in the comments as well and the __needs-image__ tag will be removed from the METADATA column.
== Creating a cover image
Articles that require a cover image are in the __TO-EDIT__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure].
Articles that require a cover image are in the __TO-EDIT__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board of the Fedora Magazine Pagure].
Since multiple people will be potentially completing this step, they need to coordinate in comments in the card.
Since multiple people will potentially be completing this step, they need to coordinate with comments on the card.
**Create a cover image** for the article. See the xref:creating-an-image.adoc[Creating a featured image] page for instructions.
To **Create a cover image** for the article, see the xref:creating-an-image.adoc[Creating a featured image]
page for instructions. This function is usually done by an editor but the author may take on this task if
they have a specific idea. Please carefully read over xref:creating-an-image.adoc[Creating a featured image] for restriction on form and source for any image used.
When done, indicate that the image is complete in the comments and remove the __needs-image__ tag by selecting the "pencil" icon in the METADATA colum and removing the tag.
When the image is done this will be indicated in the comments and the __needs-image__ tag will be remove from the METADATA column by an editor.
== Workflow
**Previous step:** xref:workflow-review.adoc[Review]

6
modules/ROOT/pages/workflow-review.adoc
View file

@ -8,15 +8,15 @@ The Editorial Board makes a decision whether the article is ready to go.
== Reviewing an article
Articles that are ready for review are in the __REVIEW__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure].
Articles that are ready for review are in the __REVIEW__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board of the Fedora Magazine Pagure].
=== When article is good to go
If the article is good to go, a member of the Editorial Board simply moves it to the __TO-EDIT__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure].
If the article is good to go, a member of the Editorial Board simply moves it to the __TO-EDIT__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board].
=== When article needs changes
If the article needs changes, a member of the Editorial Board provides feedback in the comments section of the respective card, and moves it back to the __IN-PROGRESS__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure].
If the article needs changes, a member of the Editorial Board provides feedback in the comments section of the respective card, and moves it back to the __IN-PROGRESS__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board].
== Workflow
**Previous step:** xref:writing-an-article.adoc[Writing]

6
modules/ROOT/pages/workflow.adoc
View file

@ -12,10 +12,12 @@ Content on the Fedora Magazine is created using a 5-step workflow:
4. xref:workflow-review.adoc[Review] by Editors
5. xref:workflow-edit-image.adoc[Edit & Image] by Editors
An initial proposal lands in the __idea__ state. After some clarification, a specific article goes through 5 states starting as an __IDEAS__, progressing as __IN-PROGRESS__, __REVIEW__, __TO-EDIT__, and finally ends up being __SCHEDULED__. Each step in the workflow has its own page in this documentation that provides guidance.
An initial proposal lands in the __idea__ state. After some clarification, a specific article goes through 5 states. Starting as an __idea__, it progresses to __in progress__, __review__, __to edit__, and finally ending up being __scheduled__. Each step in the workflow has its own page in this documentation that provides guidance.
== Tracking
Proposals in the **__idea__** state are among the general discussion in the https://discussion.fedoraproject.org/c/project/magazine[Fedora Magazine Discourse forum]. Everyone is welcome to submit one!
Articles in **all other states** are represented as cards in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure], each state having its own column on the board. Join our team either as a xref:contributing.adoc[writer] or as an xref:editorial.adoc[editor], and help us make wonderful content read by tens of thousands of readers every week!
Articles in **all other states** are represented as cards in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban section of the Fedora Magazine Pagure]. Each state has its own column on the board with the appropriate title.
Join our team either as a xref:contributing.adoc[writer] or as an xref:editorial.adoc[editor], and help us make wonderful content read by tens of thousands of readers every week!

18
modules/ROOT/pages/writing-an-article.adoc
View file

@ -7,21 +7,25 @@ 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://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board of the Fedora Magazine Pagure] (so you can indicate progress and exchange information with the editors) and to our https://fedoramagazine.org/admin[Wordpress instance] (where the articles are written). Read the xref:getting-access.adoc[Getting Access] page for more information.__
https://pagure.io/fedora-magazine-newsroom/boards/articles[Fedora Magazine Pagure] (so you can indicate progress and exchange information with the editors) and to our https://fedoramagazine.org/admin[Wordpress instance] (where the articles are written). Read the xref:getting-access.adoc[Getting Access] page for more information.__
== Writing an article
=== 1. Choose what to write
**Choose** any article you like in the __IDEAS__ column in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board of the Fedora Magazine Pagure].
**Choose** any article you like in the __IDEAS__ column in the
https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board of the Fedora Magazine Pagure].
Or, https://docs.fedoraproject.org/en-US/fedora-magazine/workflow-article-proposal/[propose your own].
**Assign** the card you've chosen to yourself by opening the card and selecting the "Pencil" icon in the METADATA column on the right hand side. Click on the "None-Take" option under __Assignee__ will assign the card to you.
**Assign** Open a topic, if necessary in the the https://discussion.fedoraproject.org/c/project/magazine[Fedora Magazine Discourse forum], and let the editors know you would like to be the author of an article.
Make certain you tell them the number. If you have been in contact with the editors regarding an article, simply let them know in your ongoing conversation.
**Move it to __IN-PROGRESS__** back in the https://pagure.io/fedora-magazine-newsroom/boards/articles[Kanban board of the Fedora Magazine Pagure]. Simply drag the card to the appropriate column.
The editors will assign the article to you and move it to **__IN-PROGRESS__** in the
https://pagure.io/fedora-magazine-newsroom/boards/articles[Fedora Magazine Kanban board].
=== 2. Write it
**Write** your article in https://fedoramagazine.org/admin[in the Magazine Wordpress] (create a new article there). Read the xref:writing-guidelines.adoc[Writing Guidelines] page for specific guidance about our preferred writing style.
**Write** your article https://fedoramagazine.org/admin[in the Magazine Wordpress] (create a new article there). Read the xref:writing-guidelines.adoc[Writing Guidelines] 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.
@ -29,11 +33,11 @@ As you write your draft, try to understand and follow the xref:writing-guideline
=== 3. Mark it as done
**Move it to __REVIEW__** when done with writing. Please include a link to the Wordpress Preview for your article in the comments on the card before moving it to the __REVIEW__ column so the Editors can access it.
When you feel you are done writing the article and it is ready for review, state that in a comment on your card in Pagure. The editors will **Move it to __REVIEW__**. Please make certain you include a link to the Wordpress Preview for your article in the comments on the card 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 will be moved back to the __IN-PROGRESS__ column. Please make the requested change and move it back to __REVIEW__ when you are done.
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 will be moved back to the __IN-PROGRESS__ column. Please make the requested change and let the editors know in the comments. They will move it back to __REVIEW__.
== Workflow
**Previous step:** xref:workflow-clarification.adoc[Clarification]