#41 updated teh readme with a newer workflow for using git
Merged 2 years ago by pfrields. Opened 2 years ago by ryanlerch.
ryanlerch/fedoramagazine-images update-readme  into  master

file modified
+59 -26

@@ -1,8 +1,8 @@ 

  Images for the Fedora Magazine

  ==============================

  

- This repo holds the Source SVGs for the graphics we design for the Featured 

- Images on the Fedora Magazine. 

+ This repo holds the Source SVGs for the graphics we design for the Featured

+ Images on the Fedora Magazine.

  

  Each article in the Fedora Magazine must have a featured image. The

  image gives the article added visual appeal. It also appears in links

@@ -25,8 +25,8 @@ 

  * a 192px bleed area at the left and right of the 1890px width, some

    social sites automatically crop wider images, and keeping content

    in these bleeds makes sure your lettering and icons are not truncated

-   by these sites. The template.svg has guides to show both vertical and 

-   horizontal bleed markers. 

+   by these sites. The template.svg has guides to show both vertical and

+   horizontal bleed markers.

  

  * exported images that are uploaded to WordPress can either be PNGs or

    JPGs. If you have an image that uses a photo, please convert it to a

@@ -65,7 +65,7 @@ 

    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::

@@ -124,34 +124,67 @@ 

  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/forks/<yourusername>/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:

  

- To ask for review, you will use Pagure's pull request function.  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*.

+     git pull --rebase upstream master

  

- * Open a Terminal and go to the *fedoramagazine-images/images/*

-   folder::

+ 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::

  

-     cd projects/fedoramagazine-images/images/

+     git checkout -b <my-new-image-branch>

  

- * Add your new image to be tracked in git::

+ 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 using-inkscape.svg

+     git add images/<my-new-image.svg>

  

- * Now commit it with a log message::

+ Then commit it with a log message::

  

-     git commit -m 'Image for Using Inkscape article'

+     git commit -m 'add your commit message here'

  

- * Push back to your repository::

+ 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

+     git push --set-upstream origin <my-new-image-branch>

  

- * 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

-   your repo at

-   https://pagure.io/forks/<username>/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.

+ 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

+ your repo at

+ https://pagure.io/forks/<username>/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.

no initial comment

Ryan,

The only thing I can think to add here (since you helpfully guided me through the process) would be the creation of a public/private key and where to place the public key in Pagure. I ended up a somewhat confused about whether to use http: or ssh: and eventually followed the error messages to the settings here under "Public SSH key *", but it took a while.

Thanks for the help and the updated guide.

I'm going to file an issue on the SSH key fixes and go ahead and merge this, it's too useful to wait longer.

Pull-Request has been merged by pfrields

2 years ago
Metadata