From 9b63956abb994c46e908e7f2df2e44634b29919b Mon Sep 17 00:00:00 2001 From: rlengland Date: May 07 2026 22:45:42 +0000 Subject: Demobilization of the repository. --- diff --git a/README.md b/README.md index 7ed658b..104581d 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,7 @@ # Fedora Magazine docs -This repository contains sources of the [Fedora Magazine documentation](https://docs.fedoraproject.org/en-US/fedora-magazine/). +# ⚠️ THIS REPOSITORY HAS MOVED -## Technical information +This repository has been migrated to [Forgejo]( https://forge.fedoraproject.org/magazine/fedora-magazine) and is **no longer maintained here**. -``` -|-- README.md -|-- antora.yml ....................... 1. -|-- build.sh ......................... 2. -|-- preview.sh ....................... 3. -|-- site.yml ......................... 4. -`-- modules - `-- ROOT ......................... 5. - |-- assets - | `-- images ............... 6. - | `-- pizza.png - |-- nav.adoc ................. 7. - `-- pages .................... 8. - |-- index.adoc - |-- page.adoc - `-- another-page.adoc -``` - -1. Metadata definition. -2. A script that does a local build. Uses docker. -3. A script that shows a preview of the site in a web browser by running a local web server. Uses docker. -4. A definition file for the build script. -5. A "root module of this documentation component". Please read below for an explanation. -6. **Images** to be used on any page. -7. **Menu definition.** Also defines the hierarchy of all the pages. -8. **Pages with the actual content.** They can be also organised into subdirectories if desired. - -### Local preview - -This repo includes scripts to build and preview the contents of this repository. - -**NOTE**: Please note that if you reference pages from other repositories, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions. - -Both scripts work on Fedora (using Podman) and macOS (using Docker). - -To build and preview the site, run: - -``` -$ ./build.sh && ./preview.sh -``` - -The result will be available at http://localhost:8080 - -### Installing Podman on Fedora - -Fedora Workstation doesn't come with Podman preinstalled by default — so you might need to install it using the following command: - -``` -$ sudo dnf install podman -``` +New issue reports and pull requests should be sent to the Forgejo repo here: [Fedora Magazine ](https://forge.fedoraproject.org/magazine/) diff --git a/antora.yml b/antora.yml deleted file mode 100644 index ffc9ace..0000000 --- a/antora.yml +++ /dev/null @@ -1,16 +0,0 @@ -# Name will be mostly visible in the URL. Treat it as an indentifier. -# Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page) -name: fedora-magazine # <---- PLEASE MODIFY - -# Title will be visible on the page. -title: Fedora Magazine # <---- PLEASE MODIFY - -# If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version. -version: master - -# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise. -# start_page: ROOT:index.adoc - -# This lists all the menu definitions of your component. -nav: -- modules/ROOT/nav.adoc diff --git a/build.sh b/build.sh deleted file mode 100755 index 1e4db2d..0000000 --- a/build.sh +++ /dev/null @@ -1,46 +0,0 @@ -#!/bin/sh - -image="docker.io/antora/antora" -cmd="--html-url-extension-style=indexify site.yml" - -if [ "$(uname)" == "Darwin" ]; then - # Running on macOS. - # Let's assume that the user has the Docker CE installed - # which doesn't require a root password. - echo "" - echo "This build script is using Docker container runtime to run the build in an isolated environment." - echo "" - docker run --rm -it -v $(pwd):/antora $image $cmd - -elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then - # Running on Linux. - # Check whether podman is available, else faill back to docker - # which requires root. - - if [ -f /usr/bin/podman ]; then - echo "" - echo "This build script is using Podman to run the build in an isolated environment." - echo "" - podman run --rm -it -v $(pwd):/antora:z $image $cmd - - elif [ -f /usr/bin/docker ]; then - echo "" - echo "This build script is using Docker to run the build in an isolated environment." - echo "" - - if groups | grep -wq "docker"; then - docker run --rm -it -v $(pwd):/antora:z $image $cmd - else - echo "" - echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password." - echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/." - echo "" - sudo docker run --rm -it -v $(pwd):/antora:z $image $cmd - fi - else - echo "" - echo "Error: Container runtime haven't been found on your system. Fix it by:" - echo "$ sudo dnf install podman" - exit 1 - fi -fi diff --git a/graphics-sources/fedora-magazine-workflow.svg b/graphics-sources/fedora-magazine-workflow.svg deleted file mode 100644 index a285306..0000000 --- a/graphics-sources/fedora-magazine-workflow.svg +++ /dev/null @@ -1,2027 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - Article proposal - by anyone - - idea (proposed) - - - 1 - - - - - Clarification - by editors - - - 2 - - idea (proposed) - - idea (approved) - - - - - Writing - by a writer - - idea (approved) - - in progress - - review - - - - 3 - - - - - Review - by editors - - - - 4 - - in progress - - review - - to edit - - - - - - Edit & Image - by editors - - Review - by editors - - Writing - by a writer - - Article proposal - by anyone - - - idea (proposed) - - idea (approved) - - in progress - - review - - to edit - - - scheduled - - - - - - - Clarification - by editors - - - - - - - 1 - 3 - 5 - 2 - 4 - - Publication - by WordPress - - - - - - - Edit & Image - by editors - - to edit - - - scheduled - - - 5 - - Publication - by WordPress - - - - - - - Review - by editors and writer - - - - 4 - - in progress - - to edit - - - - - Edit & Image - by editors - - Review - by editorsand writer - - Writing - by a writer - - Article proposal - by anyone - - - idea (proposed) - - idea (approved) - - in progress - - to edit - - - scheduled - - - - - - Clarification - by editors - - - - - - - 1 - 3 - 5 - 2 - 4 - - Publication - by WordPress - - - - - Following were created for thetransition from Pagure to Discourse - - diff --git a/graphics-sources/fedora-magazine-workflow_w_discourse_images.svg b/graphics-sources/fedora-magazine-workflow_w_discourse_images.svg deleted file mode 100644 index dca08ca..0000000 --- a/graphics-sources/fedora-magazine-workflow_w_discourse_images.svg +++ /dev/null @@ -1,2218 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - Article proposal - by anyone - - idea (proposed) - - - 1 - - - - - Clarification - by editors - - - 2 - - idea (proposed) - - idea (approved) - - - - - Writing - by a writer - - idea (approved) - - in progress - - review - - - - 3 - - - - - Review - by editors - - - - 4 - - in progress - - review - - to edit - - - - - - Edit & Image - by editors - - Review - by editors - - Writing - by a writer - - Article proposal - by anyone - - - idea (proposed) - - idea (approved) - - in progress - - review - - to edit - - - scheduled - - - - - - - Clarification - by editors - - - - - - - 1 - 3 - 5 - 2 - 4 - - Publication - by WordPress - - - - - - - Edit & Image - by editors - - to edit - - - scheduled - - - 5 - - Publication - by WordPress - - - - - - - Review - by editors and writer - - - - 4 - - in progress - - to edit - - - - - Edit & Image - by editors - - Review - by editorsand writer - - Writing - by a writer - - Article proposal - by anyone - - - idea (proposed) - - idea (approved) - - in progress - - to edit - - - scheduled - - - - - - Clarification - by editors - - - - - - - 1 - 3 - 2 - 4 - - Publication - by WordPress - - - - 5 - - - Following were created for thetransition from Pagure to Discourse - - - - - Writing - by a writer - - idea (approved) - - in progress - - to edit - - - - 3 - - - - diff --git a/modules/ROOT/assets/images/fedora-magazine-workflow-1.jpg b/modules/ROOT/assets/images/fedora-magazine-workflow-1.jpg deleted file mode 100644 index 488d742..0000000 Binary files a/modules/ROOT/assets/images/fedora-magazine-workflow-1.jpg and /dev/null differ diff --git a/modules/ROOT/assets/images/fedora-magazine-workflow-2.jpg b/modules/ROOT/assets/images/fedora-magazine-workflow-2.jpg deleted file mode 100644 index 84ce00f..0000000 Binary files a/modules/ROOT/assets/images/fedora-magazine-workflow-2.jpg and /dev/null differ diff --git a/modules/ROOT/assets/images/fedora-magazine-workflow-3.jpg b/modules/ROOT/assets/images/fedora-magazine-workflow-3.jpg deleted file mode 100644 index 256de1f..0000000 Binary files a/modules/ROOT/assets/images/fedora-magazine-workflow-3.jpg and /dev/null differ diff --git a/modules/ROOT/assets/images/fedora-magazine-workflow-4.jpg b/modules/ROOT/assets/images/fedora-magazine-workflow-4.jpg deleted file mode 100644 index b2dd612..0000000 Binary files a/modules/ROOT/assets/images/fedora-magazine-workflow-4.jpg and /dev/null differ diff --git a/modules/ROOT/assets/images/fedora-magazine-workflow-5.jpg b/modules/ROOT/assets/images/fedora-magazine-workflow-5.jpg deleted file mode 100644 index b43c7c4..0000000 Binary files a/modules/ROOT/assets/images/fedora-magazine-workflow-5.jpg and /dev/null differ diff --git a/modules/ROOT/assets/images/fedora-magazine-workflow-6.jpg b/modules/ROOT/assets/images/fedora-magazine-workflow-6.jpg deleted file mode 100644 index d544b10..0000000 Binary files a/modules/ROOT/assets/images/fedora-magazine-workflow-6.jpg and /dev/null differ diff --git a/modules/ROOT/assets/images/fedora-magazine-workflow.jpg b/modules/ROOT/assets/images/fedora-magazine-workflow.jpg deleted file mode 100644 index db7e348..0000000 Binary files a/modules/ROOT/assets/images/fedora-magazine-workflow.jpg and /dev/null differ diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc deleted file mode 100644 index dd4f880..0000000 --- a/modules/ROOT/nav.adoc +++ /dev/null @@ -1,21 +0,0 @@ -* xref:index.adoc[About Fedora Magazine] -* xref:workflow.adoc[Editorial Workflow] -** xref:workflow-article-proposal.adoc[1 Article Proposal] -** xref:workflow-clarification.adoc[2 Clarification] -** xref:writing-an-article.adoc[3 Writing] -** xref:workflow-review.adoc[4 Review] -** xref:workflow-edit-image.adoc[5 Edit & Image] -* xref:writing-a-pitch.adoc[Proposing Articles] -* xref:contributing.adoc[Contributing as a Writer] -** xref:getting-access.adoc[Getting Access] -** xref:writing-guidelines.adoc[Writing Guidelines] -* xref:creating-an-image.adoc[Creating a Featured Image] -* xref:editorial.adoc[Contributing as an Editor] -** xref:editor-of-the-week.adoc[Editor of the Week] -** xref:editorial-checklist.adoc[Editorial Checklist] -** xref:editorial-meetings.adoc[Editorial Meetings] -** xref:approving-comments.adoc[Approving Comments] -** xref:adding-a-writer.adoc[Adding a Writer] -* xref:technical.adoc[Technical Notes and Processes] -** xref:technical-theme.adoc[Maintaining the Theme] -** xref:technical-wordpress.adoc[WPEngine Operations] diff --git a/modules/ROOT/pages/adding-a-writer.adoc b/modules/ROOT/pages/adding-a-writer.adoc deleted file mode 100644 index 3fa3ce5..0000000 --- a/modules/ROOT/pages/adding-a-writer.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Adding a Writer - -include::partial$workflow-change-banner.adoc[] - -When a new writer joins the Magazine, they usually want to track their work in our kanban. - -. 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 `. -. Follow these instructions to xref:technical-wordpress.adoc#_changing_a_users_role[promote the account] to the Author role in WPEngine. diff --git a/modules/ROOT/pages/approving-comments.adoc b/modules/ROOT/pages/approving-comments.adoc deleted file mode 100644 index dfdf4fe..0000000 --- a/modules/ROOT/pages/approving-comments.adoc +++ /dev/null @@ -1,19 +0,0 @@ -= Approving comments - -include::partial$workflow-change-banner.adoc[] - -We moderate comments on the Fedora Magazine to make sure discussions stay constructive and useful. Some sites do not moderate comments, which usually results in spammers, trolls, or other bad actors creating a less appealing environment. Fedora Magazine editors agree that: - - * The Magazine is not a public place, but rather is like private property where we are holding an open-door event. - * We want the Magazine to retain a high value to the public and the community -- in other words, for all attendees to enjoy the event. - * We want to discourage bad actors from creating a negative environment -- in other words, that the event stays safe for everyone. - -Most comments that come in are constructive. Even comments that are critical can be constructive. However, some comments cross a line where they stop being constructive. They may express hostility or include no valuable ideas -- or simply may be spam. - -Therefore, Magazine editors follow a common set of guidelines to approve comments, and discard those that are not constructive. If you are helping moderate comments, here are some guidelines to follow: - - * Comments that are critical of a technology or article are OK to approve. However, they should offer alternative ideas or suggestions. - * Comments that criticize an author, or are hostile to a class of people, or put down Fedora in general should be discarded. - * Comments that point to technologies Fedora doesn't ship are OK to approve; the site has a legal disclaimer that says content expresses the views of individual authors only. - * Comments that are indirect spam should be discarded. You can usually recognize these comments because they are very general, do not include any context from the article, and include a product or other suspect URL as an author name and/or site. - * Duplicate comments should be discarded. (Sometimes comment authors don't read the text that tells them their comment will be held and moderated.) diff --git a/modules/ROOT/pages/contributing.adoc b/modules/ROOT/pages/contributing.adoc deleted file mode 100644 index 6a6e450..0000000 --- a/modules/ROOT/pages/contributing.adoc +++ /dev/null @@ -1,19 +0,0 @@ -= Contributing as a Fedora Magazine Writer - -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: - - * 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! - -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.** diff --git a/modules/ROOT/pages/creating-an-image.adoc b/modules/ROOT/pages/creating-an-image.adoc deleted file mode 100644 index 3df2886..0000000 --- a/modules/ROOT/pages/creating-an-image.adoc +++ /dev/null @@ -1,94 +0,0 @@ -= Creating a featured image for the Fedora Magazine - -include::partial$workflow-change-banner.adoc[] - -Each article in the Fedora Magazine must have a featured image. The image gives the article added visual appeal. It also appears in links on social media, to attract more viewers. - -These images are created as SVG (scalable vector graphic) images. To work with these images, you should install a SVG capable application such as Inkscape. You will also need the git utility installed. - -Watch the https://youtu.be/F6Nf1gsR9S4[Creating Featured Images Workshop video] on our YouTube channel for a visual demo of the guidelines and instructions below, plus some additional Inkscape tips. - -== Important guidelines - -* Only use the Fedora logo occasionally, such as for important announcements, or to indicate a project affinity. -* Do not use logos from other projects. Most require permission for use, and it is difficult to assign a recipient for permission in a group-owned project like the Magazine. -* Only use acceptably licensed pictures, photos, or screenshots, or ones that you have made yourself and thus can contribute with such a license. __(More on this below.)__ - -== Getting the image repository - -Open a Terminal. (You’ll type commands into the terminal for some of the following steps.) - -Install the git and inkscape packages if you don’t have them installed already: - - - $ sudo dnf install git inkscape - -Fork the image repository at https://pagure.io/fedoramagazine-images[fedoramagazine-images] . - -== Creating a new image using the template - -Open Inkscape, and choose File > Open… (or hit Ctrl+O). Navigate to the project folder, then into fedoramagazine-images, then into images. Choose the template.svg file. - -Save this as a new file with a different name. - -You can use the assets inside this file to start with the right-sized document, with some pre-configured backgrounds. Feel free to look at other SVGs for guidance. If you don’t have experience with these images, try to stick with fonts and motifs that you see in recent banners. But also feel free to experiment! For instance, use photographs (freely licensed, such as CC-BY or CC-BY-SA) with a text overlay for a nice look. https://unsplash.com/[Unsplash.com] has a large library of images in the public domain you can use to get started. - -== Reusing an old image - -It makes sense to reuse an old image if there is a thematic link from the previous article to the new one. Try to vary something about the image, such as the text. If the background is abstract (not a photo), consider rebalancing the color. - -When you reuse an old image, be careful that you have all the correct fonts installed. To see a list, you can run this command: - - grep font | sed 's/^.*font-family:\([^;]*\).*$/\1/' - -You can ignore font names "serif" and "sans-serif." Be sure to install any fonts that you don't have on your system already, so the image is rendered correctly both on your screen and when you build a JPG later. - -=== Background images - -You can find compatibly licensed images at https://unsplash.com[Unsplash], or you can try other image search engines. Be sure to choose only images with CC0, CC-BY, or CC-BY-SA licenses. (Commercial and derivative uses must be permissible.) - -=== Dimensions - -Before you import your background to the SVG, scale and trim it using GIMP or another image editor to an 1890x800 size, and a JPG quality of about 75-80%. This keeps the SVG from being too large -- it will reduce the size from many MB to just a few hundred KB. - -The SVG template contains guidelines to indicate what portion of the cover image's edge might get clipped when the article is shared on various social media sites. The portion that might get clipped is about 10% of the left and right sides of the image and about 13% of the top and bottom. In the SVG template, the guidelines provide margins of exactly 183 pixels on the left and right and 107 pixels on the top and bottom for an image that is sized to 1890x800 pixels. This leaves an interior region of 1524x586 pixels within which it is safe to place text without concern that it will get clipped when the article is shared out to other social media sites. - -=== Fonts - -There are a few fonts that are commonly used in featured images. You are encouraged to use these fonts in your images to help featured images fit into the general “theme” that other images follow. They are all freely available at the links provided. The fonts we commonly use on the Fedora Magazine are listed below. - -. https://www.fontsquirrel.com/fonts/open-sans[Open Sans] (especially the "Light" variant) -. https://www.fontsquirrel.com/fonts/bungee[Bungee] (for a slightly technical but fun feel) -. https://www.fontsquirrel.com/fonts/oswald[Oswald] (for a more technical feel) -. https://www.fontsquirrel.com/fonts/josefin-slab[Josefin Slab] (friendly with serifs) -. https://www.fontsquirrel.com/fonts/zilla-slab[Zilla Slab] (friendly with serifs) -. https://www.fontsquirrel.com/fonts/grand-hotel[Grand Hotel] (for a fancy script-y feel) -. https://www.fontsquirrel.com/fonts/montserrat[Montserrat] (friendly and Sans-like) -. https://www.fontsquirrel.com/fonts/roboto-slab[Roboto Slab] (friendly with serifs) -. https://www.fontsquirrel.com/fonts/molot[Molot] (heavier font, feels technical) - -To use these fonts on your Fedora system, either download the font and unpack the OTF or TTF file (if required) into your ~/.fonts folder. Then update your font cache: - - $ fc-cache - -or, where the font is packaged, install it using the package manager - - $ dnf install open-sans-fonts vernnobile-oswald-fonts mozilla-zilla-slab-fonts astigmatic-grand-hotel-fonts julietaula-montserrat-fonts google-roboto-slab-fonts typetype-molot-fonts - -You will need to close and reopen Inkscape, GIMP, or other applications to take advantage of the new fonts. - -== Getting your work reviewed - -If you’d like to post your work somewhere, convert it to a JPG first. This will typically be a smaller file. Make sure your SVG file is saved in the fedoramagazine-images/images/ folder as above. Typically these should be named after the article in some way to make it easier to find images later. For this example, let’s assume your SVG file is named using-inkscape.svg. - -Open a Terminal and go to the fedoramagazine-images/images/ folder: - - $ cd projects/fedoramagazine-images/images/ - -Now use the helpful make target we’ve provided. This creates the correct sized (1890x800 pixels) JPG automatically, if you provide the same name as your SVG file: - - $ make using-inkscape.jpg - -Now you can post this file, using-inkscape.jpg, online, and then provide that URL in the comments section of your article's Pagure card for review. - -If the image is approved, and if it might be reused for later articles, then consider creating a pull request against the upstream repository to have your work archived for reuse. diff --git a/modules/ROOT/pages/editor-of-the-week.adoc b/modules/ROOT/pages/editor-of-the-week.adoc deleted file mode 100644 index cbe339d..0000000 --- a/modules/ROOT/pages/editor-of-the-week.adoc +++ /dev/null @@ -1,32 +0,0 @@ -= Fedora Magazine Editor of the Week - -include::partial$workflow-change-banner.adoc[] - -In order to promote accountability and spread the workload, we have the Editor of the Week role for Fedora Magazine. - -== Selection - -The Editor of the Week will be selected by volunteer basis at each week's Magazine Editorial Board meeting. -Editors who cannot attend the meeting can volunteer by contacting the current Editor of the Week prior to the start of the meeting. -If the meeting is canceled, the current Editor of the Week should coordinate selection via the asynchronous communication channel (i.e. mailing list or Discourse). - -If multiple Editors volunteer to be the Editor of the Week, we expect they can work it out among themselves. -However, in general we should prefer the volunteer who has least recently served as Editor of the Week in order to fairly distribute the workload. - -If no one volunteers, then the current Editor of the Week should request volunteers via the asynchronous communication channel. - -== Term - -The term of the Editor of the Week is one calendar week (beginning the Sunday following the meeting where the Editor of the Week was selected and ending on Saturday). - -== Responsibilities - -The Editor of the Week is expected to: - -* Routinely moderate comments (2-3 times a day is ideal) -* Ensure the publication schedule is followed -* Welcome new contributors -* Convert approved proposals to Pagure cards -* Chair the weekly xref:editorial-meetings.adoc[Magazine Editorial Board meeting] - -Note that Editors who are not the Editor of the Week may still perform the tasks above. diff --git a/modules/ROOT/pages/editorial-checklist.adoc b/modules/ROOT/pages/editorial-checklist.adoc deleted file mode 100644 index 15082f2..0000000 --- a/modules/ROOT/pages/editorial-checklist.adoc +++ /dev/null @@ -1,54 +0,0 @@ -= Checklist for editors - -Editors should follow this checklist to help articles meet standards before being published. - -== Special notes for release announcements - -* [ ] Set the article slug to match the pattern `announcing-fedora-` for final releases and `announcing-fedora--beta` for beta releases. -This pattern is expected for things like the CommonBugs templates in the wiki. -* [ ] Do *not* schedule the post. -Release announcements should be published manually after confirming the website is up to date, etc. - -In addition to the release announcement, each new release is accompanied by articles describing new or changed features and other information. A list of these articles and proposed publication dates can be found at this site where XX is the current Fedora Linux release number: - -\https://fedorapeople.org/groups/schedule/f-XX/f-XX-magazine-tasks.html - -== Formatting - -* [ ] Ensure the author's first and last name appears in the preview. If not, follow the instructions xref:technical-wordpress.adoc[here]. -* [ ] After the introductory paragraph, include the __--- Read More ---__ element. This causes RSS readers to visit the site to view the article. -* [ ] Remove any monospace text mixed into paragraphs, such as elements. Either convert these to italics, or move them into Preformatted blocks in WPEngine, fixing surrounding text as necessary. - -== Style - -* [ ] Check the article for adherence to the xref:writing-guidelines.adoc[guidelines for writers]. **This may take a while, so leave yourself sufficient time for this step.** -* [ ] Set all article and section titles to sentence case. - -== Usage - -* [ ] Eliminate use of __I, we, us,__ and __our__ in the article, rewriting where necessary. Articles should not refer to the author if avoidable. - -== SEO and metadata - -* [ ] Set an appropriate https://yoast.com/focus-keyword/[focus keyword]. -* [ ] Address any article shortcomings that affect readability. (It may not be possible to turn the readability score to "green" in all cases.) -* [ ] Categorize the article. The default "Fedora Project community" category should rarely be used. -* [ ] Add tags for article subject matter. Use as many as possible. As you type a new tag, observe the popup help. Try to choose relevant tags, and avoid creating new ones with trivial differences. -* [ ] Add an Excerpt in the document details in WPEngine. This shows up in the https://en.wikipedia.org/wiki/RSS[RSS] feed shown in https://start.fedoraproject.org[start page in Fedora's web browser defaults]. -* [ ] Set the article slug. -This should exclude common short words like "of", "and", and "the". -The slug should give a sense of what the article is about but be succicnt. -Putting the focus keyword at the beginning of the slug will make the SEO plugin happy. - -== Featured images - -* [ ] Make sure the article has an appropriate xref:creating-an-image.adoc[featured image]. This is **not** the same as an image in the article text itself, and should not appear there. Use the Featured Image box in the document details in WPEngine. -* [ ] Featured images should be captioned with an appropriate attribution if they are not original or make use of third party components. -* [ ] Featured images **submitted by the author** should be captioned using **Contributed by:** and indicate the author's name. -* [ ] Featured images should be included or submitted to the https://pagure.io/fedoramagazine-images[featured images repo on Pagure]. Refer to the xref:creating-an-image.adoc[documentation on featured images] for more information. - -== Publishing - -* [ ] Schedule the article to publish at 08:00 UTC (the Magazine default timezone) on the selected day, unless decided otherwise. -* [ ] Schedule for **Beta** and **General Availability** releases is approximately 14:00 UTC so the article for those should be published at 14:00 UTC or a short time after that on the selected day, unless decided otherwise. Ref. https://docs.fedoraproject.org/en-US/releases/lifecycle/#_development_schedule[Fedora Linux Releases Life Cycle]. -* [ ] For articles that are part of a series, it is necessary to visit the post in WPEnginer AFTER it has been published and add the series indicator. Refer to the section *Adding an article to a series* in the xref:technical-wordpress.adoc[WPEngine Operations] page for instructions. diff --git a/modules/ROOT/pages/editorial-meetings.adoc b/modules/ROOT/pages/editorial-meetings.adoc deleted file mode 100644 index 540bc2e..0000000 --- a/modules/ROOT/pages/editorial-meetings.adoc +++ /dev/null @@ -1,158 +0,0 @@ -= Fedora Magazine editorial meetings - -include::partial$workflow-change-banner.adoc[] - -The goal of this meeting is to set and execute a publishing schedule of appropriate material for the Fedora Magazine. - -:hash: # - -Meetings happen every week in the https://matrix.to/#/#meeting-2:fedoraproject.org?web-instance%5Belement.io%5D=chat.fedoraproject.org[{hash}meeting-2:fedoraproject.org] Matrix channel on chat.fedoraproject.org. -See the https://calendar.fedoraproject.org/meeting/10800/[Fedora Magazine Editorial board meeting] in the Fedora calendar. -Meetings are chaired by that week's xref:editor-of-the-week.adoc[Editor of the Week]. -If the meeting time changes, be sure to update the link in this paragraph. - -== Chairing the meeting - -The meeting is powered by https://fedoraproject.org/wiki/Zodbot[zodbot]. You can use the following commands the start the meeting, to set topics, record important information and decisions, etc. - - -=== Roll call - -To start the meeting, run the following set of commands. - - !startmeeting magazine - !meetingname magazine - !topic roll call - !chair glb rlengland - -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/ publishing schedule -- - !info -- 5/ editor of the Week -- - !info -- 6/ open floor -- - - -=== 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 WPEngine]. On the https://fedoramagazine.org/wp-admin/index.php[Dashboard], scroll down to Stats by Jetpack. - - !info Week of : K pageviews -- - - -=== 2/ In progress followup - - !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 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/ - -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-/f--magazine-tasks.html - -(where is the release being developed) - -=== 3/ Finished articles to review - - !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 - -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/ Publishing schedule - - !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 - - -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 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: - 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 - -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: - DAY DATE, NAME (NICK:edit/NICK:image) --  - DAY DATE, NAME (NICK:edit/NICK:image) -- - DAY DATE, NAME (NICK:edit/NICK:image) -- - - -=== 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 5/ editor of the Week - -Announce the volunteer using: - - !info XXXX will be Editor of the Week next week - -=== 6/ Open floor - - !topic 6/ open floor - - -=== Meeting ends - - !endmeeting - - -=== After the meeting - -Send the minutes to the forum. That includes the three links zodbot prints out after the meeting is ended. - -Subject: Editorial board meeting recap YYYY-Mmm-DD - -https://discussion.fedoraproject.org/new-topic?category=project&tags=magazine-team[Forum] - -== Exceptions - -The following types of articles generally can route around the weekly meetings. This helps us get critical information out to the audience without waiting for the next board meeting. - -* **Security updates:** Critical security updates that affect a broad user audience are pre-authorized. Generally an editor will write the update article. If possible, one other editor does a quick spot check. If that would affect the timing, however, the posting editor simply publishes the article and notifies the magazine list. An example is a Firefox security issue. diff --git a/modules/ROOT/pages/editorial.adoc b/modules/ROOT/pages/editorial.adoc deleted file mode 100644 index e2f8718..0000000 --- a/modules/ROOT/pages/editorial.adoc +++ /dev/null @@ -1,12 +0,0 @@ -= Contributing as a Fedora Magazine Editor - -include::partial$workflow-change-banner.adoc[] - -The duties of an editor are much like any blog owner. Occasionally editors also xref:contributing.adoc[contribute content] when the queue or backlog of content is running a little low. -Editors take turns serving as the xref:editor-of-the-week.adoc[Editor of the Week]. - -Editors follow an xref:editorial-checklist.adoc[editorial checklist] to help articles meet a quality and content bar, and to ensure they're well searchable. - -Editors hold a xref:editorial-meetings.adoc[weekly editorial meeting] to discuss and approve content, help guide authors, and figure out ways to improve the Magazine and further its mission. The best way to become an editor is to join the weekly meeting, and demonstrate your ability to contribute consistently. - -Like most blogs and news sites, the Magazine receives feedback and comments from the public. Editors xref:approving-comments.adoc[moderate comments based on common guidelines]. They ensure that discussions stay constructive and discourage trolls and other bad actors. diff --git a/modules/ROOT/pages/getting-access.adoc b/modules/ROOT/pages/getting-access.adoc deleted file mode 100644 index 6380d36..0000000 --- a/modules/ROOT/pages/getting-access.adoc +++ /dev/null @@ -1,19 +0,0 @@ -= Getting access - -include::partial$workflow-change-banner.adoc[] - - -**1. Get a Fedora Account**: -If you don’t already have one, https://accounts.fedoraproject.org/#register[sign up here]. -Note that contributors are required to sign the Fedora Project Contributor Agreement (FPCA). - -**2. Sign in to the Fedora Magazine**: -https://fedoramagazine.org/wp-admin/[Sign in to the Fedora Magazine WPEngine dashboard] using your Fedora account. - -**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. -The Fedora Magazine editors monitor this Discourse forum and will be able to help you and answer any Fedora -Magazine related questions. - diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc deleted file mode 100644 index 3156dbf..0000000 --- a/modules/ROOT/pages/index.adoc +++ /dev/null @@ -1,41 +0,0 @@ -= Fedora Magazine - -include::partial$workflow-change-banner.adoc[] - -https://fedoramagazine.org[Fedora Magazine] is a __WPEngine-based__ site which delivers all the news of the Fedora Community. (It replaced the older publication, Fedora Weekly News.) - -== What does the Magazine publish? - -The content of the magazine varies, but mostly includes: - -* General Announcements / News -* Tips on how to use software in Fedora -* Ideas for cool apps to try -* Ways to more effectively develop software using Fedora -* DIY hardware projects you can power with Fedora -* ... And everything else related to Fedora in general! - -== Join the Magazine Team - -We really need your help on the Magazine. Consider xref:contributing.adoc[writing an article]. -There is also a detailed guide on how to make a post on the magazine. - -We also have regular xref:editorial-meetings.adoc[editorial board meetings] on chat.fedoraproject.org. -See the https://discussion.fedoraproject.org/t/meeting-and-publication-schedule/34554[Meeting and Publication Schedule] -for exactly when and where. - -:hash: # - -We also have two areas on the discussion.fedoraproject.org forum for Fedora Magazine topics. -One section (under the _Team Workflows_ category) is reserved just for article proposals. -When you start a new topic there, the post should be pre-populated with a simple outline that you can complete to make a new proposal. -The other area is for anything else related to Fedora Magazine. -These can be posts about the site theme, the tools and platforms being used in the workflow, -when weekly meetings will be held (or skipped), or anything else. -All non-article-proposal posts concerning Fedora Magazine should be tagged with the special _{hash}magazine_ tag. - -* Chat Room: https://matrix.to/#/#magazine:fedoraproject.org?web-instance%5Belement.io%5D=chat.fedoraproject.org[{hash}magazine:fedoraproject.org] (powered by https://matrix.org[Matrix]) -* Forum: https://discussion.fedoraproject.org/ -** Click https://discussion.fedoraproject.org/new-topic?category=workflows/magazine[here] to start a new article proposal. -** Click https://discussion.fedoraproject.org/new-topic?category=project&tags=magazine-team[here] to start a new conversation about anything else related to Fedora Magazine. - diff --git a/modules/ROOT/pages/technical-theme.adoc b/modules/ROOT/pages/technical-theme.adoc deleted file mode 100644 index dfd33e7..0000000 --- a/modules/ROOT/pages/technical-theme.adoc +++ /dev/null @@ -1,69 +0,0 @@ -= Maintaining the Magazine Theme - -The Magazine theme is maintained in -https://pagure.io/fedoramagazine-theme[a Pagure repository]. -If you want to submit a change, start by forking and/or cloning this repository. -This page does not cover git workflow; -consult https://git-scm.com/doc[git documentation] for more information, -or ask the Magazine staff for help. - -== Testing your changes - -The `build.sh` and `preview.sh` scripts let you deploy WPEngine in a local container -to test your work before you push your changes to the live site. -Ensure you are in the root of the cloned repository and enter -`./build.sh && ./preview.sh` to create and provision the container. -This will take some time. - -When done, you can point your local browser at http://localhost:5055 -to see the theme with your local revisions. -The container accesses the contents of the repo directly, -so you can edit changes in the repository and quickly see them in action. -To iterate on changes, after modifying the theme, -run `podman restart wordpress` from another terminal window -so the containers's web caching is cleared. -Then refresh your browser window (F5 or Ctrl+F5) to view the modifications. - -When finished, press **Ctrl**+**C** in the original terminal window -from which you launched the container to stop the container. -Optionally, you can run `./clean.sh` to remove all the contianer artifacts -except for the repo itself from your system. -If you remove all the artifacts (WPEngine plugins, databases, etc.) -it will take longer to run the `build.sh` and `preview.sh` commands the -next time because everything will need to be re-downloaded and re-installed. - -== Tagging the theme - -Once the theme modifications are complete, you should make a release. This means that anyone can return to this iteration of the theme in case of a problem with a future version. - -The last commit in your changes should be updating the `fedoramagazine/styles.css` file to update the `version` in the header: - ----- -Theme Name: Fedora Magazine 2018 -Text Domain: fmag2018 -Theme URI: http://pagure.org/fedoramagazine-theme/ -Version: 1.03 -Description: The theme for the Fedora Magazine. This iteration first rolled out in March 2018 ----- - -_(For theme committers:)_ Apply a tag to this commit to mark it for release, such as `v1.03`, and push the tag to the repo using `git push --tags`. - -== Releasing the theme - -While in the repo, run these commands to make a zip file in which to deliver the theme. **Remember to use the correct, new version number in place of 1.03 below.** - ----- -$ ln -s fedoramagazine fedoramagazine-1.03 -$ zip -r /tmp/fedoramagazine-theme-1.03.zip fedoramagazine-1.03 -$ rm -f fedoramagazine-1.03 ----- - -The resulting `fedoramagazine-theme-1.03.zip` is a release of the theme. - -== Installing the updated theme - -This step must be done by someone with "administrator" rights in the Fedora Magazine WPEngine site. - -Use the built-in functions to add a new theme. Upload the resulting `fedoramagazine-theme-1.03.zip` file and activate it. - -If you need to switch themes and get confused about which theme is correct, the theme details will show you the version number. diff --git a/modules/ROOT/pages/technical-wordpress.adoc b/modules/ROOT/pages/technical-wordpress.adoc deleted file mode 100644 index 078bb7a..0000000 --- a/modules/ROOT/pages/technical-wordpress.adoc +++ /dev/null @@ -1,157 +0,0 @@ -= WPEngine Operations - -== Adding a new user - -Do *not* add new users manually. -User accounts are created on login with Fedora account System credentials. - -== User details - -We use real names on the Magazine for authors. -This reflects accountability for posts on a more official Fedora outlet. - -Locate the user in the _Users_ control panel, and select _Edit_. -Switch the default display of the user name to first and last name. - -== User permissions - -We use the _User Role Editor_ plugin to manage user permissions at a fine-grained level. -There are five roles in our WPEngine instance: - -* **Administrator** -This role has the ability to make settings changes and conduct other administrative tasks. -* **Author** -This role has the ability to create and edit (unpublished) posts, moderate comments, and upload files. -Authors may be granted this role, and should be if they are repeat contributors. -* **Contributor** -This is the default role. -This role has the ability to create and edit (unpublished) posts. -* **Editor** -This role has many abilites, including the ability ot edit published posts and posts by other authors. -Magazine editors should have this role. -* **Subscriber** -This role only allows for reading posts. -We probably don't need to add anyone to this role in general. - -=== Changing a user's role - -In the https://fedoramagazine.org/wp-admin/[WPEngine dashboard]: - -. Select *Users* on the left-hand menu -. Search or browse for the desired user -. Hover over the desired user's row and click "Edit" -. Change the *Role* dropdown to the desired role -. Click the *Update User* button - -== Adding an article to a series - -Fedora Magazine uses "series" in WPEngine to display related articles in a sidebar. -This is often used for Copr articles. -However, adding an article to a series is not straightforward. -In the https://fedoramagazine.org/wp-admin/[WPEngine dashboard]: - -. Select *Posts* on the left-hand menu -. Search or browse for the desired posts -. Click *Quick Edit* -. In the *Post Series* box, type the name of the desired series -. Click *Update* - -If you do not know what the name of the series is, you can look in the https://fedoramagazine.org/wp-admin/edit-tags.php?taxonomy=post_series[Post Series] screen. -This is located under the *Posts* section of the left-hand menu. - -== Update the current release image/text/link in the Fedora Magazine sidebar - -The Fedora Magazine WPEngine site contains a column on the right side of the page -that includes several "Widgets". One of these contains the default image (often -the background) for the latest version and links to _fedoraproject.org_ and the -appropriate release announcement. - -The information in this widget must be changed when a new release occurs. This -section describes the process for making the necessary changes. - - -=== Navigate to the Sidebar Widget - -In the https://fedoramagazine.org/[Fedora Magazine Page] select: - -. Select: "Fedora Magazine" -+ -This is the second item from the left in the menu bar on https://fedoramagazine.org -. Now select the following from the pulldown menu: -+ - Appearances > Customize - -. Then: -+ - Widgets > Sidebar - -You are now in the "Customizing Widgets" window. - -Each item in this window is shown vertically as it appears in -the right hand sidebar menu on the Fedora magazine page. This starts with -the "Search Fedora Magazine (magnifying glass)" followed by the -currently available Fedora Linux version, subscription option, and so on. - -=== Add the feature image for the new Fedora Linux version - -Select the currently available image and then select "Add media". The items -in the Media library will be shown. Select the feature image for the -new Fedora linux version announcement from the media library. - -There will now be two images appearing. - -=== Edit the HTML text - -Select the "Text" tab and edit the html that now appears as follows: - -. Remove the html tag for the previous version - -. Correct the text in "...available now." to reflect the new version number - -. Change the "release announcement" link to point to the new release announcement. - -==== Text editing example - -In this example the changes reflect moving from Fedora 43 to 44. - -After adding the second image the text might appear as follows: - -.... - - - - - Fedora Linux 43 is available now. - Read the - release announcement for all the details. -.... - -The for f43 should be removed. The first anchor text should be edited to -reflect the new version number (44 in this case). The link to https://fedoraproject.org -should be left as-is. - -The second anchor should be changed to reflect the new Fedora Magazine -announcement URL, for version 44, in this example. - -The results should appear similar to the following: - -.... - - - Fedora Linux 44 is available now. - Read the - release announcement for all the details. -.... - -=== Commit your changes - -When done go to the top of the "Customizing > Widget" window and select the -"Publish" button. diff --git a/modules/ROOT/pages/technical.adoc b/modules/ROOT/pages/technical.adoc deleted file mode 100644 index 037c245..0000000 --- a/modules/ROOT/pages/technical.adoc +++ /dev/null @@ -1,5 +0,0 @@ -= Technical Notes and Processes - -The Magazine site itself is simply a https://wpengine.com/[WPEngine site]. Like any website, it may require maintenance from time to time. - -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]. diff --git a/modules/ROOT/pages/workflow-article-proposal.adoc b/modules/ROOT/pages/workflow-article-proposal.adoc deleted file mode 100644 index a4f37d2..0000000 --- a/modules/ROOT/pages/workflow-article-proposal.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= Proposing Articles - -include::partial$workflow-change-banner.adoc[] - -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. - -== 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. - -**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 - -__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 - -== Workflow -**Next step:** xref:workflow-clarification.adoc[Clarification] diff --git a/modules/ROOT/pages/workflow-clarification.adoc b/modules/ROOT/pages/workflow-clarification.adoc deleted file mode 100644 index f406cf3..0000000 --- a/modules/ROOT/pages/workflow-clarification.adoc +++ /dev/null @@ -1,33 +0,0 @@ -= Clarifying Proposals - -include::partial$workflow-change-banner.adoc[] - -image::fedora-magazine-workflow-2.jpg[,100%,] - -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. -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. - -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, 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. - -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] - -**Next step:** xref:writing-an-article.adoc[Writing] diff --git a/modules/ROOT/pages/workflow-edit-image.adoc b/modules/ROOT/pages/workflow-edit-image.adoc deleted file mode 100644 index 781e4b8..0000000 --- a/modules/ROOT/pages/workflow-edit-image.adoc +++ /dev/null @@ -1,46 +0,0 @@ -= Editing and Creating Images - -include::partial$workflow-change-banner.adoc[] - -image::fedora-magazine-workflow-5.jpg[,100%,] - -Before an article can be published, it needs to be edited, and it needs a cover image. - -Members of the Editorial Board provide both of those. - -== Editing - -Articles that require editing 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]. - -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 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 by indicating the image editor - -== Creating a cover image - -Articles that require a cover image 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]. - -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 by the editor. - -== Scheduling - -When editing is completed and an appropriate image is included, an editor will schedule the article for publication -on the indicated date and time. - -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:workflow-review.adoc[Review] diff --git a/modules/ROOT/pages/workflow-review.adoc b/modules/ROOT/pages/workflow-review.adoc deleted file mode 100644 index 37dbb29..0000000 --- a/modules/ROOT/pages/workflow-review.adoc +++ /dev/null @@ -1,33 +0,0 @@ -= Reviewing Articles - -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 be published. - -== Reviewing an article - -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 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 on this 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 proposed _Publication Date_ -in the Discussion topic, and finalizes the editing and image creation in the next step. - -== Workflow -**Previous step:** xref:writing-an-article.adoc[Writing] - -**Next step:** xref:workflow-edit-image.adoc[Edit & Image] diff --git a/modules/ROOT/pages/workflow.adoc b/modules/ROOT/pages/workflow.adoc deleted file mode 100644 index f747022..0000000 --- a/modules/ROOT/pages/workflow.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= Fedora Magazine Editorial Workflow - -include::partial$workflow-change-banner.adoc[] - -image::fedora-magazine-workflow.jpg[,100%,] - -Content on the Fedora Magazine is created using a five-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 - -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, it ends up being _published_. -Each step in the workflow has its own page in this documentation that provides guidance. - -== Tracking - -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 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] -and help us make wonderful content read by tens of thousands of readers every week! diff --git a/modules/ROOT/pages/writing-a-pitch.adoc b/modules/ROOT/pages/writing-a-pitch.adoc deleted file mode 100644 index 52feff9..0000000 --- a/modules/ROOT/pages/writing-a-pitch.adoc +++ /dev/null @@ -1,14 +0,0 @@ -= Proposing Articles for Fedora Magazine - -include::partial$workflow-change-banner.adoc[] - -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] diff --git a/modules/ROOT/pages/writing-an-article.adoc b/modules/ROOT/pages/writing-an-article.adoc deleted file mode 100644 index fbb37a7..0000000 --- a/modules/ROOT/pages/writing-an-article.adoc +++ /dev/null @@ -1,77 +0,0 @@ -= Writing Articles - -include::partial$workflow-change-banner.adoc[] - -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://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[WPEngine 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** - -You may always https://docs.fedoraproject.org/en-US/fedora-magazine/workflow-article-proposal/[propose your own] article. - -**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 WPEngine] -(create a new article there). If you are familiar with WordPress, WPEngine works the same. -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 certain you set the article status -from __Draft__ to __Pending Review__ once you receive approval. You can also "Enable public preview" if -you wish others to review the artical before publication. - -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 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 WPEngine **preview** for your article in the comments on the -Discussion topic so the Editors can access it. - -And that's it! - -Note that in some cases the editors might require or suggest a change in your article. -If that occurs you will 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] - -**Next step:** xref:workflow-review.adoc[Review] diff --git a/modules/ROOT/pages/writing-guidelines.adoc b/modules/ROOT/pages/writing-guidelines.adoc deleted file mode 100644 index b62b2ca..0000000 --- a/modules/ROOT/pages/writing-guidelines.adoc +++ /dev/null @@ -1,101 +0,0 @@ -= Tips for article style, grammar, content, and SEO - -include::partial$workflow-change-banner.adoc[] - -These tips will help your article sail through editing. Be kind to your editor(s), and read this before you start. - -== Markup - -Primary rule: don’t get too fancy. Legibility is important. - -. **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__. -. **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 -** commands or package names -. **Use the Preformatted style in the WPEngine editor for command line input or output.** Use a shell prompt ($ or #) only where it genuinely affects the meaning, or to set the input apart from output. It also helps to use boldface for the input itself: -+ -[subs=quotes] ----- -$ **command arg1 arg2** -output line 1 -output line 2 ----- - - -. **Use boldface only for an extremely important phrase or statement.** - - -== Grammar and style tips - -. **Use sentence case for the post title and heading titles.** Don’t capitalize words in your article title or any heading, other than proper nouns. This avoids needless arguments about title case, which differs by region. -** Incorrect heading: __Use Sentence Case for Post Titles in Fedora Magazine__ -** Correct heading: __Use sentence case for post titles in Fedora Magazine__ -. **Check spelling and grammar.** Nobody likes nitpicky comments about this. Check your work before you send it to an editor. Editors: double-check all the work, that’s your job! -. **Write clearly and use shorter sentences.** Brevity is good. Clarity is better. Don’t be excessively wordy when avoidable. If a longer sentence is easier to read, use the extra words. -. **Avoid passive voice.** Passive voice is the use of the object of a sentence as the subject. For example: -** __Active voice__: The troops defeated the enemy. -** __Passive voice__: The enemy was defeated by the troops. -. **Be careful of gerunds (-ing words).** They usually indicate passive voice. Rewrite your sentence to make it stronger. For example: -** __Weak, passive voice__: Setting the foobar configuration option will make the application listen on all interfaces. -** __Strong, active voice__: Set the foobar configuration option to make the application listen on all interfaces. -. **Avoid unnecessary future tense.** Unless you're actually talking about future plans or publications, present tense is best. -** __Unnecessary future tense__: When you select **Run**, your program will start. -** __Present tense__: When you select **Run**, your program starts. -. **Avoid too much use of the verb __to be__ in sentences.** Too much use of is, will be, or can be makes your sentences weak and flabby. Try using the verb form of words you’ve shuffled off elsewhere in the sentence. Often you can simply drop words, or use the imperative (commanding or advising) form of the sentence. -** __Weak__: Zambone is an app used for managing your private documents on a server. -** __Strong__: Zambone manages your private documents on a server. Or: Use Zambone to manage your private documents on a server. -** __Weak__: When setting up a file server, it is important to plan the directory structure carefully. -** __Strong__: Plan the directory structure of the file server carefully before you set it up. -. **Use standard US English for spelling and other international differences.** US English is the lingua franca for the Fedora Project overall. -. **Have a smooth flow from general information to specific instructions.** If you’re not sure how to structure your article like this, check out our starter template. - -== Content tips - -These tips are about things to do — and avoid — in what you tell users to do. Remember that thousands of readers trust Fedora Magazine to tell them how to carry out tasks. Be responsible and helpful, advocate best practices, and respect the user’s security and choice. - -. **Leave packaged files alone.** Processes should not involve editing files under system folders like __/usr__ or __/lib*__. Edit __/etc__ or a user-specific configuration in the home directory. -. **Prefer free software where practical (and officially packaged software wherever possible).** The Magazine can still cover non-FOSS software to be used on Fedora, where we know or suspect that software is very popular and useful to Fedora users. (Google Chrome is a good example.) But if your article is covering a general process, use FOSS software. -. **Use libvirt/KVM in tips, not VirtualBox or other hypervisors.** Frequently people coming from other platforms have VirtualBox experience. However, the KVM hypervisor and libvirt in Fedora are FOSS and part of the platform. Use them, write about them, love them. -. **Unless necessary, use Fedora family distributions.** The Fedora Magazine promotes Fedora. Unless the point of your article is to specifically explain a cross-distribution mechanism, use installations, containers, or distributions within its family (Fedora, CentOS, RHEL). -. **Copr software must be accompanied by a caveat.** The Copr build system is not managed by the Fedora release team and does not provide official software builds. If you cover some software from Copr, ensure there’s no official build. If not, include a statement like this: __Copr is not officially supported by Fedora infrastructure. Use packages at your own risk.__ -. **Avoid exclusionary or problematic language.** These are examples of terminology to avoid wherever possible in articles: -.. **blacklist/whitelist** — Use __allowlist/denylist__ instead, which is more directly descriptive of the purpose. -.. **master/slave** — Use __primary/secondary__, __primary/replica__, __active/passive__, __active/standby__, or another similar construct. -. **Test your process.** If possible, use a fresh guest VM — or at least a brand-new user account. Run your process from beginning to end to ensure it works. Fix, rinse, and repeat. -. **Use the correct style for third parties.** Names of companies, projects, and technologies don't always follow the style rules of typical English words. -Choose the styling used by authoritiative websites when you're unsure. -If authoritaive sources use inconsistent style, use your best judgment. -A non-exhaustive list: -.. *Copr* instead of _COPR_ -.. *NVIDIA* instead of _Nvidia_ or _nVidia_ -.. *Perl* instead of _PERL_ -.. *Red Hat* instead of _Redhat_ or _RedHat_ -.. *ThinkPad* instead of _Thinkpad_ - -== Image and screenshot tips - -. **Use a fresh, standard Fedora Workstation**, not your personal desktop or setup. -(It's best to make a VM with a fresh Fedora Workstation install, and do the steps there.) -If you're showing something that *relies* on another desktop, do a fresh installation and use that. -. **Set screen resolution at a reasonable but not too high resolution**, such as 1280x960 or 1280x800. -. If you're only showing a browser window, make it fairly large on the screen and **screenshot only the browser**. (Hint: you can use the Screenshot app for this!) -. If you're only showing an application, **use the default size of the app to screenshot it**. -. **Upload and use that original media in your article.** -If the shot is large, like a large browser window, app, or whole screen, choose a medium size thumbnail and let WPEngine handle the conversion. - -== WPEngine tips - -. **Use a simple, relevant title.** Preferably this should be a call to action, like __Build a widget using GTK+__, or a list description, like __5 fun games in Fedora__. The title affects search engines, and leads to more hits and higher page ranking. That helps drive traffic to the Magazine. -. **Provide a featured image.** Look at https://fedoramagazine.org/creating-a-featured-image-for-a-fedora-magazine-article/[the information here] for tips on featured images. You can also feel free to ask the editors to assign this for you. If you make your own image, try to match the style of other images. Use the assets provided https://fedoramagazine.org/creating-a-featured-image-for-a-fedora-magazine-article/[in the featured image guide]. Don’t add your own fonts or deviate from the guide. -. **Use good SEO practices.** Use the SEO plugin provided to maximize the search ranking of the article. Aim for a “green” rating in the __Publish__ box at top right of your article’s edit screen. Follow these guidelines: -** Enter a meaningful keyword in the SEO box under your article. (Most articles shouldn’t use __Fedora__.) -** If the Snippet doesn’t give an effective introduction or summary in the sample search result, rewrite it. -** Don’t feel like you have to eliminate every warning. A “green” rating overall is the only goal. -. **Use the Edit as HTML option when pasting into preformatted blocks.** Current versions of WPEngine are known to strip leading hash marks (#) and leading whitespace when content is pasted into preformatted blocks. Some non-alphanumeric characters may also get garbled (&, <, >, etc.). Using the __Edit as HTML__ option (listed under the vertical ellipsis) prior to pasting content into the block seems to workaround this problem. Be sure to paste your content between the 
 tags and do not overwrite them. After pasting your content, switch back to visual mode by using the __Edit visually__ option to see a better representation of what the final result will look like to the reader.
-
-== Other hints
-
-:hash: #
-
-Got an idea for better writing? Discuss with the editors in the https://matrix.to/#/#magazine:fedoraproject.org?web-instance%5Belement.io%5D=chat.fedoraproject.org[{hash}magazine:fedoraproject.org] Matrix channel on chat.fedoraproject.org.
diff --git a/modules/ROOT/partials/workflow-change-banner.adoc b/modules/ROOT/partials/workflow-change-banner.adoc
deleted file mode 100644
index e69de29..0000000
--- a/modules/ROOT/partials/workflow-change-banner.adoc
+++ /dev/null
diff --git a/nginx.conf b/nginx.conf
deleted file mode 100644
index f7093b3..0000000
--- a/nginx.conf
+++ /dev/null
@@ -1,14 +0,0 @@
-server {
-    listen       80;
-    server_name  localhost;
-
-    location / {
-        root   /antora/public;
-        index  index.html index.htm;
-    }
-
-    error_page   500 502 503 504  /50x.html;
-    location = /50x.html {
-        root   /usr/share/nginx/html;
-    }
-}
diff --git a/preview.sh b/preview.sh
deleted file mode 100755
index acc52af..0000000
--- a/preview.sh
+++ /dev/null
@@ -1,18 +0,0 @@
-#!/bin/sh
-
-if [ "$(uname)" == "Darwin" ]; then
-    # Running on macOS.
-    # Let's assume that the user has the Docker CE installed
-    # which doesn't require a root password.
-    echo "The preview will be available at http://localhost:8080/"
-    docker run --rm -v $(pwd):/antora:ro -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro -p 8080:80 nginx
-
-elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
-    # Running on Linux.
-    # Fedora Workstation has python3 installed as a default, so using that
-    echo ""
-    echo "The preview is available at http://localhost:8080"
-    echo ""
-    cd ./public
-    python3 -m http.server 8080
-fi
diff --git a/site.yml b/site.yml
deleted file mode 100644
index 590092c..0000000
--- a/site.yml
+++ /dev/null
@@ -1,20 +0,0 @@
-site: 
-  title: Fedora Magazine
-  start_page: fedora-magazine::index.adoc
-content:
-  sources:
-   - url: .
-     branches: HEAD
-ui:
-  bundle:
-    url: https://asamalik.fedorapeople.org/ui-bundle.zip
-    snapshot: true
-  default_layout: with_menu
-output: 
-  clean: true 
-  dir: ./public
-  destinations: 
-  - provider: archive 
-runtime:
-  fetch: true
-  cache_dir: ./cache