From b11ad4ccbd68f21434171e4cdfd9911e5c817266 Mon Sep 17 00:00:00 2001 From: Ben Cotton Date: Jan 25 2021 13:58:48 +0000 Subject: Link to existing documentation We have a lot of docs duplicated here, so we should point to the other documentation, which is generally more helpful and more accurate. I leave some of the old docs here because it's nice to have a local reference for a few things, but we could also consider making this file nothing but links to the docs.fedoraproject.org pages. --- diff --git a/README.rst b/README.rst index 4cd318d..58bd8d6 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,8 @@ 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. +Quick guidelines and git usage instructions are below. For full documentation +on creating a featured image, see `the Fedora Magazine docs `_. Image Guidelines ---------------- @@ -32,14 +34,6 @@ help them look their best on the Magazine site. These are: JPGs. If you have an image that uses a photo, please convert it to a JPG to reduce the filesize. - -Getting commit access to this repo ----------------------------------- - -Please join and send an email to the marketing list if you want commit -access. Otherwise, pull requests are also welcomed. - - How to use this repo -------------------- @@ -47,35 +41,22 @@ 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. -Getting started with the image repository -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* Use the Fork control near the top of this page to fork a copy of the - 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:: - - su -c "dnf install git inkscape" - -* If desired, change directory into the folder where you like to store - your project work. This example uses the folder name projects, but - you should use a folder you have on your system. This step is - optional:: - cd projects -* Now clone your forked repository of Fedora Magazine images:: +Getting started with the image repository +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - git clone https://pagure.io/fork//fedoramagazine-images +Follow the instructions in the `Git for docs writers `_ +documentation. Creating a new image using the template ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Install inkscape package if you don't have it installed already:: + + su -c "dnf install inkscape" + * Open Inkscape, and choose *File > Open...* (or hit *Ctrl+O*). Navigate to the project folder, then into *fedoramagazine-images*, then into *images*. Choose the @@ -96,103 +77,19 @@ in the public domain you can use to get started. When done, if you enter the *images* folder, you can create a JPEG version of your creation in the correct aspect using the provided -*Makefile*. If your file is called *foo.svg*, simply run the command +*Makefile*. If your file is called *foo.svg*, run the command *make foo.jpg* to create the JPEG version. This can be uploaded to the Fedora Magazine as a featured image. -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. - -* Montserrat_ (friendly and Sans-like) -* `Roboto Slab`_ (friendly with serifs) -* Molot_ (heavier font, feels technical) -* `Grand Hotel`_ (for a fancy script-y feel) - -.. _Montserrat: https://www.fontsquirrel.com/fonts/montserrat -.. _`Roboto Slab`: https://fontsquirrel.com/fonts/roboto-slab -.. _Molot: https://fontsquirrel.com/fonts/molot -.. _`Grand Hotel`: https://fontsquirrel.com/fonts/grand-hotel - -To use these fonts on your Fedora system, download the font and unpack -the OTF or TTF file (if required) into your *~/.fonts* folder. Then -update your font cache:: - - fc-cache - -You will need to close and reopen Inkscape, GIMP, or other -applications to take advantage of the new fonts. - Getting your work reviewed ========================== -Initial git repo setup -~~~~~~~~~~~~~~~~~~~~~~ - -These inital repo setup steps only need to be followed the first time you setup -and start hacking on images. - -When you first start adding images to this repo, first you will need to create -a fork of the fedoramagazine-images project in the Pagure web UI. - -Once you have created your fork, on your system, check out your fork using the -SSH git URL. for example: - - git clone ssh://git@pagure.io/fork//fedoramagazine-images.git - -Then change into your checkout with: - - cd fedoramagazine-images - -Next, setup the repo so we can track the changes from this main upstream repo: - - git remote add upstream https://pagure.io/fedoramagazine-images.git - -Git workflow -~~~~~~~~~~~~ - -Once you have set up your repo as per the inital repo setup above, use the following -steps each time you create a new image. - -First, ensure you are in your checkout of fedoramagazine-images, and change to the -master branch with:: - - git checkout master - -Now pull down the latest changes from the main repo with: - - git pull --rebase upstream master - -Next, create a new branch where we are going to add the new image. change -my-new-image-branch to something useful for the image you are working on:: - - git checkout -b - -Create your image in Inkscape, and save the file in the `images/` directory, -in your git repo. Then add your new image to be tracked in git:: - - git add images/ - -Then commit it with a log message:: - - git commit -m 'add your commit message here' - -Push back to your repository (be sure to change the name of the branch to -what you set before in the git checkout command above):: - - git push --set-upstream origin - -Then you can return to Pagure and issue a Pull Request, which lets -the Magazine team know you have an image ready to review. Visit +After you have pushed your changes, can return to Pagure and submit a Pull Request. +This lets the Magazine team know you have an image ready to review. Visit your repo at: - https://pagure.io/fork//fedoramagazine-images + https://pagure.io/forks//fedoramagazine-images and you should see the Pull Request button next to the branch listing. -Select it, and follow the form to issue the PR. +Select it, and follow the form to submit the PR.