Corrected spelling, changed WPEngine to WP Engine, hopefully changed the back-tick (accent grave) to apostrophes
This commit is contained in:
parent
7c19d23d12
commit
713aef2b71
11 changed files with 35 additions and 35 deletions
|
|
@ -6,4 +6,4 @@ When a new writer joins the Magazine, they usually want to track their work in o
|
|||
|
||||
. 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 WPEngine.
|
||||
. Follow these instructions to xref:technical-wordpress.adoc#_changing_a_users_role[promote the account] to the Author role in WP Engine.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ These images are created as SVG (scalable vector graphic) images. To work with t
|
|||
|
||||
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.
|
||||
|
||||
NOTE: The video is from a previous era which indicates the use of a GIT image repository. This is NOT used at this time. However, the demostration of using Inkscape is very useful. The following time spans may be useful: Inkscape (3:30 - 38:56), installing the image in WPEngine (40:19 - 42:08), and a discussion of fonts (43:59: - 49:05). The current method to acquire the SVG template file is described later in these instructions as well as saving the SVG files for future use.
|
||||
NOTE: The video is from a previous era which indicates the use of a GIT image repository. This is NOT used at this time. However, the demostration of using Inkscape is very useful. The following time spans may be useful: Inkscape (3:30 - 38:56), installing the image in WP Engine (40:19 - 42:08), and a discussion of fonts (43:59: - 49:05). The current method to acquire the SVG template file is described later in these instructions as well as saving the SVG files for future use.
|
||||
|
||||
== Important guidelines
|
||||
|
||||
|
|
@ -18,13 +18,13 @@ NOTE: The video is from a previous era which indicates the use of a GIT image re
|
|||
|
||||
== Getting the image template
|
||||
|
||||
Open a Terminal. (You’ll type commands into the terminal for some of the following steps.)
|
||||
Open a Terminal. (You'll type commands into the terminal for some of the following steps.)
|
||||
|
||||
Install Inkscape and GIMP if you don’t have them installed already:
|
||||
Install Inkscape and GIMP if you don't have them installed already:
|
||||
|
||||
$ sudo dnf install inkscape gimp
|
||||
|
||||
Download the template file from the WPEngine Media Library using the following command to place it directly in your Templates directory.
|
||||
Download the template file from the WP Engine Media Library using the following command to place it directly in your Templates directory.
|
||||
|
||||
wget -P ~/Templates https://fedoramagazine.org/wp-content/uploads/2026/05/fedora-magazine-template.svg
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ Open Inkscape, and choose File > Open… (or hit Ctrl+O). Navigate to your Templ
|
|||
|
||||
Save this as a new SVG file with a different name using the "File > Save As..." option. Typically images should be named after the article in some way to make it easier to identify later. For example "using-inkscape.svg" might be used for an article covering that topic. Not saving ahead of time risks the inadvertent over-writing of the template later on.
|
||||
|
||||
You can use the assets inside the template 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.
|
||||
You can use the assets inside the template 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
|
||||
|
||||
|
|
@ -82,9 +82,9 @@ or, where the font is packaged, install it using the package manager
|
|||
|
||||
You will need to close and reopen Inkscape, GIMP, or other applications to take advantage of the new fonts.
|
||||
|
||||
== Getting your work prepared for review and use in WPEngine
|
||||
== Getting your work prepared for review and use in WP Engine
|
||||
|
||||
The images used in WPEngine are JPG images. But, for reuse/editing it is more conveniently done on an SVG. For this reason, both are stored in the WPEngine Media library.
|
||||
The images used in WP Engine are JPG images. But, for reuse/editing it is more conveniently done on an SVG. For this reason, both are stored in the WP Engine Media library.
|
||||
|
||||
First locate/make a directory on your local system into which you can save your work.
|
||||
|
||||
|
|
@ -94,6 +94,6 @@ To create the JPG image you will need to export your image into your local direc
|
|||
|
||||
When you are ready to post your work somewhere, use the JPG. This will typically be a smaller file. Now you can post your example image "using-inkscape.jpg" in the comments section of your article's Discourse topic for review.
|
||||
|
||||
If the image is approved, and if it might be reused for later articles, then consider uploading both the JPG and SVG image to the WPEngine Media Library. If you feel it is a one-time-use image then only the JPG needs to be uploaded.
|
||||
If the image is approved, and if it might be reused for later articles, then consider uploading both the JPG and SVG image to the WP Engine Media Library. If you feel it is a one-time-use image then only the JPG needs to be uploaded.
|
||||
|
||||
Use the JPG file as the Featured Image for your article, not the SVG.
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ In addition to the release announcement, each new release is accompanied by arti
|
|||
|
||||
* [ ] 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 <tt> elements. Either convert these to italics, or move them into Preformatted blocks in WPEngine, fixing surrounding text as necessary.
|
||||
* [ ] Remove any monospace text mixed into paragraphs, such as <tt> elements. Either convert these to italics, or move them into Preformatted blocks in WP Engine, fixing surrounding text as necessary.
|
||||
|
||||
== Style
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ In addition to the release announcement, each new release is accompanied by arti
|
|||
* [ ] 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].
|
||||
* [ ] Add an Excerpt in the document details in WP Engine. 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.
|
||||
|
|
@ -42,10 +42,10 @@ Putting the focus keyword at the beginning of the slug will make the SEO plugin
|
|||
|
||||
== 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.
|
||||
* [ ] 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 WP Engine.
|
||||
* [ ] 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 image SVGs should also be uploaded to the https://fedoramagazine.org/wp-admin/media-new.php[WPEnging Media Library] for reuse unless the image is obviously a single-use image.
|
||||
* [ ] Featured image SVGs should also be uploaded to the https://fedoramagazine.org/wp-admin/media-new.php[WP Engine Media Library] for reuse unless the image is obviously a single-use image.
|
||||
|
||||
for future use, unless it is clearly a single-use image. Refer to the xref:creating-an-image.adoc[documentation on featured images] for more information.
|
||||
|
||||
|
|
@ -53,4 +53,4 @@ for future use, unless it is clearly a single-use image. Refer to the xref:creat
|
|||
|
||||
* [ ] 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.
|
||||
* [ ] For articles that are part of a series, it is necessary to visit the post in WP Enginer 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[WP Engine Operations] page for instructions.
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ This is the standard agenda. Announcing it in advance helps newcomers understand
|
|||
|
||||
!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.
|
||||
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 WP Engine]. 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>
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ If you don’t already have one, https://accounts.fedoraproject.org/#register[si
|
|||
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.
|
||||
https://fedoramagazine.org/wp-admin/[Sign in to the Fedora Magazine WP Engine 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].
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
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.)
|
||||
https://fedoramagazine.org[Fedora Magazine] is a __WP Engine-based__ site which delivers all the news of the Fedora Community. (It replaced the older publication, Fedora Weekly News.)
|
||||
|
||||
== What does the Magazine publish?
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ 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
|
||||
The `build.sh` and `preview.sh` scripts let you deploy WP Engine 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.
|
||||
|
|
@ -36,7 +36,7 @@ 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.)
|
||||
If you remove all the artifacts (WP Engine 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.
|
||||
|
||||
|
|
@ -70,7 +70,7 @@ 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.
|
||||
This step must be done by someone with "administrator" rights in the Fedora Magazine WP Engine site.
|
||||
|
||||
Use the built-in functions to add a new theme. Upload the resulting `fedoramagazine-theme-1.03.zip` file and activate it.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WPEngine Operations
|
||||
= WP Engine Operations
|
||||
|
||||
== Adding a new user
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ 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:
|
||||
There are five roles in our WP Engine instance:
|
||||
|
||||
* **Administrator**
|
||||
This role has the ability to make settings changes and conduct other administrative tasks.
|
||||
|
|
@ -35,7 +35,7 @@ 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]:
|
||||
In the https://fedoramagazine.org/wp-admin/[WP Engine dashboard]:
|
||||
|
||||
. Select *Users* on the left-hand menu
|
||||
. Search or browse for the desired user
|
||||
|
|
@ -45,10 +45,10 @@ In the https://fedoramagazine.org/wp-admin/[WPEngine dashboard]:
|
|||
|
||||
== Adding an article to a series
|
||||
|
||||
Fedora Magazine uses "series" in WPEngine to display related articles in a sidebar.
|
||||
Fedora Magazine uses "series" in WP Engine 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]:
|
||||
In the https://fedoramagazine.org/wp-admin/[WP Engine dashboard]:
|
||||
|
||||
. Select *Posts* on the left-hand menu
|
||||
. Search or browse for the desired posts
|
||||
|
|
@ -61,7 +61,7 @@ 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
|
||||
The Fedora Magazine WP Engine 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.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
= 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.
|
||||
The Magazine site itself is simply a https://wpengine.com/[WP Engine 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].
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Anyone with good writing skills is welcome to write an article for the Fedora Ma
|
|||
__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).
|
||||
https://fedoramagazine.org/admin[WP Engine instance] (where the articles are written).
|
||||
Read the xref:getting-access.adoc[Getting Access] page for more information.__
|
||||
|
||||
== Writing an article
|
||||
|
|
@ -41,8 +41,8 @@ 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.
|
||||
Write your article https://fedoramagazine.org/admin[in the Magazine WP Engine]
|
||||
(create a new article there). If you are familiar with WordPress, WP Engine works the same.
|
||||
Read the xref:writing-guidelines.adoc[Writing Guidelines] page for specific guidance about our
|
||||
preferred writing style.
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ Also, if you write a better article, the editors are more likely to publish it s
|
|||
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
|
||||
Please make certain you include a link to the WP Engine **preview** for your article in the comments on the
|
||||
Discussion topic so the Editors can access it.
|
||||
|
||||
And that's it!
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Primary rule: don’t get too fancy. Legibility is important.
|
|||
** 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:
|
||||
. **Use the Preformatted style in the WP Engine 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]
|
||||
----
|
||||
|
|
@ -82,9 +82,9 @@ If you're showing something that *relies* on another desktop, do a fresh install
|
|||
. 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.
|
||||
If the shot is large, like a large browser window, app, or whole screen, choose a medium size thumbnail and let WP Engine handle the conversion.
|
||||
|
||||
== WPEngine tips
|
||||
== WP Engine 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.
|
||||
|
|
@ -92,7 +92,7 @@ If the shot is large, like a large browser window, app, or whole screen, choose
|
|||
** 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 <pre> 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.
|
||||
. **Use the Edit as HTML option when pasting into preformatted blocks.** Current versions of WP Engine 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 <pre> 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
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue