conversion to Discourse
This commit is contained in:
parent
2fe58944cb
commit
c0a716bc95
17 changed files with 146 additions and 429 deletions
|
|
@ -18,6 +18,4 @@
|
|||
** xref:adding-a-writer.adoc[Adding a Writer]
|
||||
* xref:technical.adoc[Technical Notes and Processes]
|
||||
** xref:technical-theme.adoc[Maintaining the Theme]
|
||||
** xref:technical-pagure.adoc[Pagure Operations]
|
||||
** xref:technical-wordpress.adoc[WordPress Operations]
|
||||
** xref:technical-zinebot.adoc[Zinebot Operations]
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@ include::partial$workflow-change-banner.adoc[]
|
|||
|
||||
When a new writer joins the Magazine, they usually want to track their work in our kanban.
|
||||
|
||||
. Ask the writer to login to link:https://pagure.io/fedora-magazine-newsroom/boards/articles[Fedora Magazine Pagure instance] if they have not done so already. This will require that they have a Fedora Account System (FAS) login.
|
||||
. Have the writer set up a Fedora Account, if they don’t already have one. They can link:https://accounts.fedoraproject.org/#register[sign up here]. Remind them that contributors are required to sign the Fedora Project Contributor Agreement (FPCA).
|
||||
. Find out the writer's Fedora Account System information. For instance, using link:https://fedoraproject.org/wiki/Zodbot[Zodbot] you can use the command `fasinfo <fas-username>`.
|
||||
. Follow these instructions to xref:technical-wordpress.adoc#_changing_a_users_role[promote the account] to the Author role in WordPress.
|
||||
|
|
|
|||
|
|
@ -4,9 +4,13 @@ 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.
|
||||
* You can xref:writing-a-pitch.adoc[propose an article] if you have your own idea.
|
||||
* If a topic has been proposed and the article is not being actively written (no activity or replies in the topic
|
||||
for usually several months or more), they are moved to the _#fm-stalled_ column in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/l/latest?board=default[Fedora Magazine Kanban board]
|
||||
These topics may be available. To determine the status of the article, leave a message on the Discussion Topic
|
||||
requesting the status and indicating your willingness to write the article. The original proposer should respond but
|
||||
if not the editors will make a decision.
|
||||
|
||||
Either way, your writing goes out to tens of thousands of readers that visit Fedora Magazine every week!
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
= Adding Contributors
|
||||
|
||||
A contributor must have a FAS account before starting. Once they do, editors should help them get necessary access to join the team.
|
||||
|
||||
The editor needs to be an "admin" in the Fedora Magazine Pagure site to complete this step.
|
||||
|
||||
== Adding to Pagure
|
||||
|
||||
Ask the contributor to login to the https://pagure.io/fedora-magazine-newsroom/boards/articles[Pagure instance], using the OpenID option and their FAS account username and password and let you know when they have done so by leaving a comment in their article card.
|
||||
|
||||
Now you can assign the new user to Pagure cards, and they'll receive notifications as appropriate.
|
||||
|
|
@ -20,99 +20,92 @@ The meeting is powered by https://fedoraproject.org/wiki/Zodbot[zodbot]. You can
|
|||
|
||||
To start the meeting, run the following set of commands.
|
||||
|
||||
#startmeeting magazine
|
||||
#meetingname magazine
|
||||
#topic roll call
|
||||
#chair glb rlengland theevilskeleton
|
||||
!startmeeting magazine
|
||||
!meetingname magazine
|
||||
!topic roll call
|
||||
!chair glb rlengland
|
||||
|
||||
People will then join using a `.hello2` or a `.hello NICK` command.
|
||||
People will then join using a `!hello2` or a `!hello NICK` command.
|
||||
|
||||
=== Agenda
|
||||
|
||||
This is the standard agenda. Announcing it in advance helps newcomers understand the structure of the meeting.
|
||||
|
||||
#topic agenda
|
||||
#link https://docs.fedoraproject.org/en-US/fedora-magazine/workflow/
|
||||
#info -- 1/ last week's stats --
|
||||
#info -- 2/ articles in progress --
|
||||
#info -- 3/ articles to review --
|
||||
#info -- 4/ articles to edit --
|
||||
#info -- 5/ publishing schedule --
|
||||
#info -- 6/ editor of the Week --
|
||||
#info -- 7/ open floor --
|
||||
!topic agenda
|
||||
!link https://docs.fedoraproject.org/en-US/fedora-magazine/workflow/
|
||||
!info -- 1/ last week's stats --
|
||||
!info -- 2/ articles in progress --
|
||||
!info -- 3/ articles to review --
|
||||
!info -- 4/ publishing schedule --
|
||||
!info -- 5/ editor of the Week --
|
||||
!info -- 6/ open floor --
|
||||
|
||||
|
||||
=== 1/ Last week's stats
|
||||
|
||||
#topic 1/ last week's stats
|
||||
!topic 1/ last week's stats
|
||||
|
||||
First, let's look back at the previous week in terms of pageviews. This data can be obtained in the https://fedoramagazine.org/admin[Fedora Magazine Wordpress]. On the https://fedoramagazine.org/wp-admin/index.php[Dashboard], scroll down to Stats by Jetpack.
|
||||
|
||||
#info Week of <MONTH DD>: <NN.N>K pageviews -- <COMMENT>
|
||||
!info Week of <MONTH DD>: <NN.N>K pageviews -- <COMMENT>
|
||||
|
||||
|
||||
=== 2/ In progress followup
|
||||
|
||||
#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://pagure.io/fedora-magazine-newsroom/boards/articles
|
||||
!topic 2/ in progress followup
|
||||
!info Looking at the 'fm-in-progress' column, is there something that's been finished? Anything to follow up on with the author?
|
||||
!link board: https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default
|
||||
|
||||
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 and commented so by the author can be moved to the "review" column.
|
||||
Anything that's already finished and commented as so by the author can be moved to the _#fm-ready-for-editing_ 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.
|
||||
|
||||
#info Are there any upcoming test days?
|
||||
#link https://calendar.fedoraproject.org/QA/
|
||||
!info Are there any upcoming test days?
|
||||
!link https://calendar.fedoraproject.org/QA/
|
||||
|
||||
Also check the release schedule for upcoming tasks.
|
||||
This is generally only important a few weeks before the Beta and Final releases, but it doesn't hurt to check just to keep it in mind.
|
||||
|
||||
#info Check the release schedule.
|
||||
#link https://fedorapeople.org/groups/schedule/f-<N>/f-<N>-magazine-tasks.html
|
||||
!info Check the release schedule.
|
||||
!link https://fedorapeople.org/groups/schedule/f-<N>/f-<N>-magazine-tasks.html
|
||||
|
||||
(where <N> is the release being developed)
|
||||
|
||||
=== 3/ Finished articles to review
|
||||
|
||||
#topic 3/ 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) column or to the 'in-progress' (needs more work) column and provide feedback.
|
||||
#link board: https://pagure.io/fedora-magazine-newsroom/boards/articles
|
||||
!topic 3/ articles to review
|
||||
!info Continue looking at the _#fm-ready-for-editing_ column. Assign each of the articles to an editor by adding the editor's name.
|
||||
!info Assign an editor for the featured image as well.
|
||||
!link board: https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default
|
||||
|
||||
Authors mark their articles as finished by adding a comment announcing that fact. Review the articles
|
||||
and ether 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_.
|
||||
Leave them in the _#fm_ready-to-edit_ column. The assigned editor will review the article and determine if it needs some additional work. If there is more work, reply to the author in the topic, providing feedback, and move it back to _#fm-in-progress_.
|
||||
|
||||
|
||||
=== 4/ Articles to edit
|
||||
=== 4/ Publishing schedule
|
||||
|
||||
#topic 4/ articles to edit
|
||||
#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
|
||||
!topic 4/ Publishing schedule
|
||||
!info Looking at the _#fm_-eady-for-editing' column, decide the publishing schedule for the upcoming week.
|
||||
!info If there is not enough content, we might also need to look at the 'in-progress' to come up with additional content.
|
||||
!link board: https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default
|
||||
|
||||
Assign an editor and a cover image designer to each article so it can be moved forward.
|
||||
|
||||
|
||||
=== 5/ Publishing schedule
|
||||
|
||||
#topic 5/ Publishing schedule
|
||||
#info Looking at the 'to-edit' column, decide the publishing schedule for the upcoming 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.
|
||||
|
||||
Decide which articles should be published when and set the dates for each card on the board.
|
||||
Decide which articles should be published when and set the dates for each topic.
|
||||
|
||||
The next step is to vote on the publishing schedule along with other attendees of the meeting. A proposal of the schedule has the following format:
|
||||
|
||||
#proposed #agreed PUBLISHING SCHEDULE:
|
||||
!proposed #agreed PUBLISHING SCHEDULE:
|
||||
DAY DATE, NAME (NICK:edit/NICK:image) --
|
||||
DAY DATE, NAME (NICK:edit/NICK:image) --
|
||||
DAY DATE, NAME (NICK:edit/NICK:image) --
|
||||
|
||||
|
||||
*NOTE!!!* The following script it is currently not available
|
||||
|
||||
This can be generated by a script. Run:
|
||||
|
||||
$ podman run --rm -it asamalik/magazine-schedule
|
||||
|
|
@ -120,33 +113,34 @@ This can be generated by a script. Run:
|
|||
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].
|
||||
*end NOTE!!!*
|
||||
|
||||
When the schedule is set and agreed upon, announce it by:
|
||||
|
||||
#agreed PUBLISHING SCHEDULE:
|
||||
!agreed PUBLISHING SCHEDULE:
|
||||
DAY DATE, NAME (NICK:edit/NICK:image) --
|
||||
DAY DATE, NAME (NICK:edit/NICK:image) --
|
||||
DAY DATE, NAME (NICK:edit/NICK:image) --
|
||||
|
||||
|
||||
=== 6/ Editor of the Week
|
||||
=== 5/ Editor of the Week
|
||||
|
||||
Before the end of the meeting, we need to select next week's xref:editor-of-the-week.adoc[Editor of the Week].
|
||||
|
||||
#topic 6/ editor of the Week
|
||||
!topic 5/ editor of the Week
|
||||
|
||||
Announce the volunteer using:
|
||||
|
||||
#info XXXX will be Editor of the Week next week
|
||||
!info XXXX will be Editor of the Week next week
|
||||
|
||||
=== 7/ Open floor
|
||||
=== 6/ Open floor
|
||||
|
||||
#topic 7/ open floor
|
||||
!topic 6/ open floor
|
||||
|
||||
|
||||
=== Meeting ends
|
||||
|
||||
#endmeeting
|
||||
!endmeeting
|
||||
|
||||
|
||||
=== After the meeting
|
||||
|
|
@ -155,6 +149,7 @@ Send the minutes to the forum. That includes the three links zodbot prints out a
|
|||
|
||||
Subject: Editorial board meeting recap YYYY-Mmm-DD
|
||||
|
||||
https://discussion.fedoraproject.org/new-topic?category=project&tags=magazine-team[Forum]
|
||||
|
||||
== Exceptions
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,4 @@ Editors follow an xref:editorial-checklist.adoc[editorial checklist] to help art
|
|||
|
||||
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.
|
||||
|
||||
Editors also xref:editorial-add-contributors.adoc[extend access to new contributors] so they can help with writing, art, and sometimes even editing itself.
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -10,15 +10,7 @@ Note that contributors are required to sign the Fedora Project Contributor Agree
|
|||
**2. Sign in to the Fedora Magazine**:
|
||||
https://fedoramagazine.org/wp-admin/[Sign in to the Fedora Magazine WordPress dashboard] using your Fedora Account.
|
||||
|
||||
**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 is so the account is known to the system and you can edit card meta-data. If an editor has already
|
||||
created a card for your idea, you should be able to assign the card to yourself. You will have to request
|
||||
that the card's overall status (i.e. the column that it is in on the board) be changed by leaving a comment
|
||||
in the card's comment section. Only the editors can update the card's status/column.
|
||||
|
||||
**4. Join the Magazine forum and introduce yourself**:
|
||||
**3. Join the Magazine forum and introduce yourself**:
|
||||
Join the discussion on the https://discussion.fedoraproject.org/tag/magazine-team[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.
|
||||
|
|
|
|||
|
|
@ -1,76 +0,0 @@
|
|||
= 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.
|
||||
|
|
@ -1,206 +0,0 @@
|
|||
= Zinebot Operations
|
||||
|
||||
Zinebot is a chatbot designed to help the xref:editor-of-the-week.adoc[editor of the week] run the xref:editorial-meetings.adoc[weekly meetings].
|
||||
Importantly, Zinebot is just an aid.
|
||||
It is not required to run the meetings.
|
||||
Its main purpose is to fetch information from various sources
|
||||
to save the meeting chair from having to jump between several browser tabs or applications
|
||||
and copy-paste information to or from the meeting chatroom.
|
||||
The meetings can still be run in the traditional way if Zinebot crashes or otherwise fails to function.
|
||||
|
||||
== Installation
|
||||
|
||||
See https://pagure.io/fedora-magazine-chatbot[the Fedora Magazine chatbot repo] for installation instructions.
|
||||
A good way to test Zinebot outside of meeting times
|
||||
is to create a private room on https://chat.fedoraproject.org[the Fedora Project Matrix homeserver]
|
||||
and invite the _zinebot_ user to the room.
|
||||
You will need to assign the room a https://github.com/vector-im/element-web/issues/13077[local address].
|
||||
You can then configure Zinebot to join that room.
|
||||
|
||||
== Commands
|
||||
|
||||
:tilde: ~
|
||||
|
||||
Most of the Zinebot commands operate against https://pagure.io/fedora-magazine-newsroom/boards/articles[the Fedora Magazine kanban board].
|
||||
Notable exceptions include the `show`, `post` and `eotw` commands.
|
||||
|
||||
All of the Zinebot commands must be prefixed with Zinebot's call sign and a space character.
|
||||
Zinebot's call sign is the unicode diamond operator (⋄).
|
||||
A convenient way to enter the diamond operator
|
||||
is by using the https://help.gnome.org/misc/release-notes/40.0/#:~:text=Improved%20Settings[compose key].
|
||||
For example, if the compose key is enabled and configured to be the right-alt key,
|
||||
then tapping the **Alt**, **<** and **>** keys in sequence should yield the diamond operator.
|
||||
If so desired, Zinebot's call sign can be changed by editing its `run` script.
|
||||
|
||||
TIP: Add the line: +
|
||||
+
|
||||
`<Multi_key> <less> <greater> : "🔹" U1F539 # SMALL BLUE DIAMOND` +
|
||||
+
|
||||
to your {tilde}/.XCompose file to remap the normal diamond operator compose sequence
|
||||
to generate a small blue diamond instead.
|
||||
You will need to restart your X11 or Wayland session for the change to take effect.
|
||||
Zinebot will accept the small blue diamond character (🔹) as an alternative call sign.
|
||||
You can still enter the normal diamond operator by tapping **Alt**, **>**, **<**.
|
||||
|
||||
TIP: The full list of predefined compose keys can be found in the
|
||||
/usr/share/X11/locale/en_US.UTF-8/Compose system file.
|
||||
|
||||
TIP: You can customize the single character codes that Zinebot will respond to
|
||||
by editing the {tilde}/.local/opt/zinebot/commands/hotkeys.pm file.
|
||||
|
||||
=== 🔹 next topic
|
||||
|
||||
Included with Zinebot is a `topics.txt` file containing a copy of xref:editorial-meetings.adoc[the meeting script].
|
||||
The `next topic` command will iteratively read the blocks of text listed in the `topics.txt` file and write them out in the chatroom.
|
||||
The text blocks in the file are separated by blank lines.
|
||||
|
||||
Some topics correlate with specific columns on the kanban board.
|
||||
When appropriate, Zinebot will scan the cards from the corresponding kanban board column
|
||||
and write them out to the chatroom as a summarized list.
|
||||
Included in the summary for each card will be
|
||||
an indication of whether or not the author has signed the Fedora Project Contributor Agreement (FPCA).
|
||||
The status of the author's FPCA signature is retrieved directly
|
||||
from the Fedora Account System each time a card is retrieved from the kanban board.
|
||||
|
||||
=== 🔹 next col[umn]
|
||||
|
||||
Internally, Zinebot keeps track of which kanban column is currently being viewed.
|
||||
This command advances to the next column on the kanban board and lists its cards.
|
||||
Normally, this command should not be needed since the `next topic` command will take care of advancing to the appropriate column.
|
||||
|
||||
=== 🔹 next card
|
||||
|
||||
Internally, Zinebot keeps track of which card on the current kanban column is being viewed.
|
||||
This command advances to the next card in the column and displays its summary.
|
||||
If you want to view a specific card rather than iterating through them in order,
|
||||
see the `view` command below.
|
||||
|
||||
As a shorthand for this command, Zinebot will accept a lone unicode _right-pointing arrow_ (→).
|
||||
The call sign should be omitted when using the shorthand.
|
||||
|
||||
=== 🔹 skip topic <number|text>
|
||||
|
||||
This command allows you to skip to a specific topic.
|
||||
For example, `skip topic agenda` or `skip topic 7`.
|
||||
This command will reset the internal topic counter such that the result of a subsequent `next topic` command will be changed.
|
||||
Otherwise, this command behaves exactly like the `next topic` command.
|
||||
|
||||
=== 🔹 show proposed
|
||||
|
||||
When the _to-edit_ column is loaded in the current internal card deck,
|
||||
this command will read the scheduled publication dates from all the cards in the deck and list them out
|
||||
along with the card titles and assigned editors as a proposed editing and publication schedule.
|
||||
|
||||
As a shorthand for this command, Zinebot will accept a lone unicode _because_ symbol (∵).
|
||||
The call sign should be omitted when using the shorthand.
|
||||
|
||||
NOTE: The default compose key sequence for the _because_ symbol is **<compose-key>**, **.**, **:**.
|
||||
|
||||
=== 🔹 show agreed
|
||||
|
||||
This command generates the same output as the `proposed` command described above.
|
||||
However, instead of starting with _#proposed_, the output will begin with _#agreed_.
|
||||
|
||||
In the background, this command will also post the agreed-upon publication schedule to Fedora Magazine's channel
|
||||
on https://discussion.fedoraproject.org[the Fedora Project Discourse forum].
|
||||
The success or failure of each attempted post is indicated
|
||||
by a respective 🔹 or 🔸 at the end of each scheduled card.
|
||||
Only articles that are scheduled for the upcoming week should post successfully.
|
||||
Anything that is scheduled for an earlier or later date should automatically fail to post.
|
||||
|
||||
As a shorthand for this command, Zinebot will accept a lone unicode _therefore_ symbol (∴).
|
||||
The call sign should be omitted when using the shorthand.
|
||||
|
||||
NOTE: The default compose key sequence for the _therefore_ symbol is **<compose-key>**, **:**, **.**.
|
||||
|
||||
=== 🔹 show testdays
|
||||
|
||||
This command scans https://calendar.fedoraproject.org/QA[the Fedora Project QA calendar] for test day events
|
||||
and displays them in the chatroom.
|
||||
The scan is limited to a three-week period that begins on Sunday of the current week.
|
||||
Test day events are identified as those whose _meeting location_ is set to _fedora-test-day*_.
|
||||
|
||||
=== 🔹 show schedule
|
||||
|
||||
This command scans https://fedorapeople.org/groups/schedule[the Fedora Project schedule] for scheduled Fedora Magazine publications
|
||||
such as beta and final release announcements.
|
||||
The results are then listed in the chatroom.
|
||||
|
||||
=== 🔹 list [column]
|
||||
|
||||
This command generates a summarized list of kanban cards from either
|
||||
the current kanban column or, if specified, the requested kanban column.
|
||||
The `next topic`, `skip topic` and `next column` commands call this command automatically.
|
||||
When a specific column is requested, all subsequent Zinebot commands will consider it the _current_ column.
|
||||
|
||||
Internally, the `next card` and `view` Zinebot commands operate against a cache of cards retrieved from the current kanban column
|
||||
rather than fetching them from Pagure each time.
|
||||
This command repopulates the internal cache whenever it is called.
|
||||
The current card is also reset to the first card in the list.
|
||||
If you modify any of the cards that are cached, you may need to rerun this command to update the internal cache.
|
||||
|
||||
=== 🔹 view [number]
|
||||
|
||||
This command does exactly the same thing as the `next card` command.
|
||||
However, unlike the latter, it allows you to specify a specific card number to display.
|
||||
The requested card must be loaded in the current card cache from a prior run of the `list` command.
|
||||
When a specific card is requested, the current card index for the next run of the `next card` command is not advanced.
|
||||
|
||||
=== 🔹 card <number> <property> [<property> ...]
|
||||
|
||||
This is a low-level command that allows you to access individual card properties.
|
||||
When provided a card number, this command operates directly against Pagure.
|
||||
This command can access cards that are not in the current column.
|
||||
The following card properties are accessible through this command.
|
||||
|
||||
[listing,indent=1]
|
||||
🞄 id
|
||||
🞄 title
|
||||
🞄 full_url
|
||||
🞄 content
|
||||
🞄 comments[:N]
|
||||
🞄 <any-custom-field-name>
|
||||
|
||||
By default, the last three comments are retrieved from the card when the `comments` property is requested.
|
||||
The number of comments to retrieve can be specified by appending **:N** to the property name where **N** is a positive integer.
|
||||
All card comments can be requested by appending **:0** to the property name.
|
||||
|
||||
=== 🔹 move <number> <column> [row]
|
||||
|
||||
This command moves the specified card to the specified kanban column.
|
||||
Optionally, the row offset at which the card should be placed in the target column can be specified.
|
||||
By default, cards are moved to the top of the target column (row 1).
|
||||
|
||||
As a shorthand, you can use the unicode characters ← or → in place of the column name
|
||||
to signify the previous or next column respectively.
|
||||
|
||||
NOTE: The default compose key sequence for the _leftwards arrow_ symbol is **<compose-key>**, **<**, **-**.
|
||||
|
||||
NOTE: The default compose key sequence for the _rightwards arrow_ symbol is **<compose-key>**, **-**, **>**.
|
||||
|
||||
=== 🔹 ping <number> <comment>
|
||||
|
||||
This command adds a one-line comment to the specified card.
|
||||
Pagure should send an email notification to the card's assignee containing the comment.
|
||||
The comment does not need to be quoted.
|
||||
Everything after the card number is considered part of the comment.
|
||||
|
||||
=== 🔹 post <title> [date [time]]
|
||||
|
||||
This command posts an event to the Fedora Magazine calendar on Fedora's Discourse forum.
|
||||
If the date is not specified, it defaults to one week from the current day.
|
||||
If the time is not specified, it defaults to the beginning of the current hour.
|
||||
Dates must be specified as YYYY-MM-DD.
|
||||
Times must be specified as HH:MM:SS.
|
||||
Times are in Coordinated Universal Time (UTC).
|
||||
The title does not need to be quoted.
|
||||
Anything that does not match a date or time pattern is considered part of the event title.
|
||||
|
||||
This command is called automatically by the `show agreed` command
|
||||
to add the agreed-upon articles to the publication calendar.
|
||||
|
||||
=== 🔹 eotw <username>
|
||||
|
||||
This command posts the editor of the week line.
|
||||
Just for fun, `king` and `queen` are aliases for this command. They may be easier to remember.
|
||||
|
||||
|
|
@ -2,6 +2,4 @@
|
|||
|
||||
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].
|
||||
|
|
|
|||
|
|
@ -6,18 +6,23 @@ image::fedora-magazine-workflow-1.jpg[,100%,]
|
|||
|
||||
Anyone is welcome to propose an article!
|
||||
|
||||
Proposals can be ideas or specific pitches (an example is below). Proposing an article doesn't automatically mean the same person needs to write it. Having a good set of ideas helps writers to write what they know is relevant for the Magazine.
|
||||
Proposals can be ideas or specific pitches (an example is below). Proposing an article doesn't automatically
|
||||
mean the same person needs to write it. Having a good set of ideas helps writers to write what they know is
|
||||
relevant for the Magazine.
|
||||
|
||||
== Submitting an idea
|
||||
|
||||
Join the community on the https://discussion.fedoraproject.org/new-topic?category=workflows/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 assigned to you.
|
||||
**NOTE** Make certain to select the _#fm-proposed_ tag before submitting and add an 'X' in the AI Assisted Contributions box.
|
||||
|
||||
All contributions MUST conform to the https://docs.fedoraproject.org/en-US/council/policy/ai-contribution-policy/[
|
||||
Fedora AI-Assisted Contributions Policy]
|
||||
|
||||
TIP: If this is your first proposal, and you also plan to write an article, you will need a Fedora Account. If you don't
|
||||
have one you may https://accounts.fedoraproject.org/#register[sign up here]. Note that contributors are required to
|
||||
sign the Fedora Project Contributor Agreement (FPCA).
|
||||
|
||||
== A specific pitch example
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ include::partial$workflow-change-banner.adoc[]
|
|||
|
||||
image::fedora-magazine-workflow-2.jpg[,100%,]
|
||||
|
||||
The Editorial Board reviews each proposal and creates a specific article description.
|
||||
The Editorial Board reviews each proposed article description.
|
||||
|
||||
Proposals might be discussed with the person who proposed them, with subject matter experts,
|
||||
and anyone who wants (or has the technical ability to) give an input.
|
||||
|
|
@ -13,22 +13,19 @@ We encourage anyone in the community to provide feedback to the proposals!
|
|||
== Discussing and approving proposals
|
||||
|
||||
Proposals are submitted to the https://discussion.fedoraproject.org/c/workflows/magazine/57[Fedora Magazine Discourse forum]
|
||||
as topics, and discussion happens right there.
|
||||
as topics, and discussion happens right there.
|
||||
|
||||
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 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 a proposal is approved, the author may commence writing and the article will be moved to the _#fm-in-progress_
|
||||
column in the https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default[Kanban board].
|
||||
This operation is performed by an editor.
|
||||
|
||||
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.
|
||||
This "Discussion topic" now represents a specific article and is used through all the other steps of the workflow.
|
||||
Communications between editors, authors, and interested parties will take place here.
|
||||
|
||||
== Workflow
|
||||
**Previous step:** xref:workflow-article-proposal.adoc[Article Proposal]
|
||||
|
|
|
|||
|
|
@ -10,26 +10,28 @@ 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 board of the Fedora Magazine Pagure].
|
||||
Articles that require editing are in the __ready-for-editing__ column in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default[Fedora Magazine Kanban board].
|
||||
|
||||
Since multiple people will be potentially completing this step, they need to coordinate with comments on the card.
|
||||
Since multiple people will be potentially completing this step, they need to coordinate with comments on the Discussion topic.
|
||||
|
||||
The editors will **Edit** the article for potential grammatical and spelling errors.
|
||||
When done, they indicate that in the comments.
|
||||
The editors will **Edit** the article for potential grammatical and spelling errors and formatting, if necessary.
|
||||
When done, they indicate that in the comments and indicate who the editor was.
|
||||
|
||||
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.
|
||||
If the cover image has also been done that will be indicated in the comments by indicating the image editor
|
||||
|
||||
== 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 board of the Fedora Magazine Pagure].
|
||||
Articles that require a cover image are in the __ready-for-editing__ column in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default[Fedora Magazine Kanban board].
|
||||
|
||||
Since multiple people will potentially be completing this step, they need to coordinate with comments on the card.
|
||||
Since multiple people will potentially be completing this step, they need to coordinate with comments on the Discussion topic.
|
||||
|
||||
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 restrictions on form and source for any image used.
|
||||
|
||||
When the image is done this will be indicated in the comments and the __needs-image__ tag will be removed from the METADATA column by an editor.
|
||||
When the image is done this will be indicated in the comments by the editor.
|
||||
|
||||
== Workflow
|
||||
**Previous step:** xref:workflow-review.adoc[Review]
|
||||
|
|
|
|||
|
|
@ -4,19 +4,29 @@ include::partial$workflow-change-banner.adoc[]
|
|||
|
||||
image::fedora-magazine-workflow-4.jpg[,100%,]
|
||||
|
||||
The Editorial Board makes a decision whether the article is ready to go.
|
||||
The Editorial Board makes a decision whether the article is ready to be published.
|
||||
|
||||
== 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 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 board].
|
||||
Articles that are ready for review are in the _#fm-ready-for-editing_ column in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default[Fedora Magazine 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 board].
|
||||
If the article needs changes, a member of the Editorial Board provides feedback in the Discussion topic for the article,
|
||||
and moves it back to the _#fm-in-progress_ column in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default[Kanban board].
|
||||
|
||||
After changes have been made the author should again notify the editors who will move it back to the
|
||||
__#fm-ready-for-editing__. There may be some iteration of the process, if necessary.
|
||||
|
||||
=== When article is good to be published
|
||||
|
||||
When the article is good to go, a member of the Editorial Board notifies the author, enters the _Publication Date_ in
|
||||
the Discussion topic and schedules the article for publication on that date.
|
||||
|
||||
A few days after publication, the Discussion topic will be moved to the _#fm_published_
|
||||
column in the https://discussion.fedoraproject.org/c/workflows/magazine/57/l/latest?board=default[Kanban board]
|
||||
|
||||
== Workflow
|
||||
**Previous step:** xref:writing-an-article.adoc[Writing]
|
||||
|
|
|
|||
|
|
@ -12,19 +12,19 @@ Content on the Fedora Magazine is created using a five-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 five states.
|
||||
Starting as an __idea__, it progresses to __in progress__, __review__, __to edit__, and finally ending up being __scheduled__.
|
||||
All initial proposal lands in the _proposed_ state.
|
||||
After some clarification, a specific article goes through several states.
|
||||
Starting as a _proposal_, it progresses to _in progress_, _ready-for-editing, and finally ending up being _published_.
|
||||
Each step in the workflow has its own page in this documentation that provides guidance.
|
||||
|
||||
== Tracking
|
||||
|
||||
Article proposals in are initiated and discussed under the _Team Workflows_ section
|
||||
Article proposals are initiated, tracked, and discussed under the _Team Workflows_ section
|
||||
of the https://discussion.fedoraproject.org/c/workflows/magazine/57[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].
|
||||
Articles in all states are represented in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/l/latest?board=default[Fedora Magazine Kanban board].
|
||||
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]
|
||||
|
|
|
|||
|
|
@ -6,6 +6,9 @@ Fedora Magazine welcomes anyone to submit ideas for articles.
|
|||
|
||||
Just propose your idea on our https://discussion.fedoraproject.org/new-topic?category=workflows/magazine[Fedora Magazine Discourse forum].
|
||||
|
||||
The topic opened there will be your means of tracking your article through the publication process.
|
||||
It will also be the way to connect with the editors if you have questions or issues.
|
||||
|
||||
See the xref:workflow-article-proposal.adoc[Editorial Workflow - Article Proposal] page for more information.
|
||||
|
||||
**Note:** All contributions MUST conform to the https://docs.fedoraproject.org/en-US/council/policy/ai-contribution-policy/[Fedora AI-Assisted Contributions Policy]
|
||||
|
|
|
|||
|
|
@ -7,58 +7,67 @@ 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[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).
|
||||
to our https://discussion.fedoraproject.org/new-topic?category=workflows/magazine[Fedora Magazine Discourse forum]
|
||||
(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].
|
||||
Or, https://docs.fedoraproject.org/en-US/fedora-magazine/workflow-article-proposal/[propose your own].
|
||||
**Choose**
|
||||
|
||||
**Assign** Open a topic,
|
||||
if necessary in the the https://discussion.fedoraproject.org/new-topic?category=workflows/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.
|
||||
You may always https://docs.fedoraproject.org/en-US/fedora-magazine/workflow-article-proposal/[propose your own] article.
|
||||
|
||||
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].
|
||||
**OR**
|
||||
|
||||
You may wish to investigate articles in the _#fm-stalled_ column in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/l/latest?board=default[Fedora Magazine Kanban board].
|
||||
|
||||
If a topic has been proposed and the article is not being actively written (no activity or replies in the topic
|
||||
for usually several months or more), they are moved to the _#fm-stalled_ column. These topics may be available.
|
||||
|
||||
Reply to the article topic and enquire about the status. The assigned author should reply and you may negotiate with
|
||||
them. If there is no reply let the editors know of your interest and it can be assigned to you and moved to
|
||||
the _#fm-in-progress_ column in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/l/latest?board=default[Kanban board].
|
||||
|
||||
**Assign**
|
||||
|
||||
If you propose an article and it is approved, it will be moved to the _#fm-in-progress_ column in the
|
||||
https://discussion.fedoraproject.org/c/workflows/magazine/l/latest?board=default[Kanban board]
|
||||
by the editors.
|
||||
|
||||
=== 2. Write it
|
||||
|
||||
**Write** your article https://fedoramagazine.org/admin[in the Magazine Wordpress]
|
||||
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.
|
||||
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.
|
||||
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 certain 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:writing-guidelines.adoc[style, grammar, and SEO guidelines] for the Magazine.
|
||||
As you write your draft, try to understand and follow the
|
||||
xref:writing-guidelines.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.
|
||||
|
||||
=== 3. Mark it as done
|
||||
|
||||
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_ in the Kanban board.
|
||||
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.
|
||||
When you feel you are done writing the article and it is ready for review, state that in a comment in your
|
||||
Discussion topic. The editors will move it to _#fm-ready-for-editing_ in the Kanban board.
|
||||
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 let the editors know in the comments.
|
||||
They will move it back to _review_.
|
||||
Please note that in some cases the editors might require or suggest a change in your article.
|
||||
In that case, you'll receive feedback in your article Discussion topic. This is discussed in
|
||||
the xref:workflow-review.adoc[Review] section.
|
||||
|
||||
== Workflow
|
||||
**Previous step:** xref:workflow-clarification.adoc[Clarification]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue