Skip to content

Commit

Permalink
Further instructions on adding images and publishing lessons
Browse files Browse the repository at this point in the history
  • Loading branch information
wcaleb committed Jan 20, 2016
1 parent 688c060 commit 7ed6e5f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions index.md
Expand Up @@ -16,4 +16,21 @@ The new workflow would work something like this:
6. An [issue](https://github.com/programminghistorian/ph-submissions/issues) is created for the new lesson, with a link to the live preview that should now exist. Reviewer comments and be made directly on this issue. When making edits to the lesson, the author may wish to include the issue number (using the `#1` syntax) in commit messages, so that a reference to the revision will show up on the ticket, though that is not strictly necessary.
7. When the lesson is ready to go, an editor will move the lesson over from the submissions repo to the main publication repo, together with related images.

An author, once given collaborator privileges, could also fairly easily upload images like this:

1. At the command line, type `git clone https://github.com/programminghistorian/ph-submissions.git`.
2. Then type `cd ph-submissions/images`, or open that directory in your GUI file explorer.
3. Now, copy all of the lesson images into this directory.
4. Then, from within the images directory, the author will do something like this:

``` bash
git add *
git commit -m "Add images for NEW LESSON NAME HERE"
git push
```

An editor, once the lesson is complete, could "publish" it by a similar method: clone both the `jekyll` and `ph-submissions` repos to his/her local computer (if he/she hasn't done so already; if they already exist locally, then `git pull` down all changes in both repos and, using `git status`, make sure you are on the `gh-pages` branch in both before proceeding). Then locally copy the new lesson from the `ph-submissions/lessons` directory to the `jekyll/lessons` directory, and do the same with the images from `ph-submissions/images` to `jekyll/images`. Now `git add`, `git commit` and `git push` the updates in the `jekyll` repository.

One downside with this method is that the revision history will be preserved only within the submissions repo, and not on the live site. But that's not a huge downside, considering potential upside in ease of workflow.

Let's try it out on a lesson or two and see how it goes.

1 comment on commit 7ed6e5f

@fredgibbs
Copy link
Contributor

@fredgibbs fredgibbs commented on 7ed6e5f Jan 21, 2016 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.