bookshtml / author-workflow Goto Github PK

Starting an issue for discussion, rather than on a completed pull request. Whatever we do, I'll cut it out eventually for the PTX documentation. So I'm thinking we write a chapter or two here, so the structural tags are at about the right level for later migration.

What about developing cheat sheets on the "edition" branch, and "workflow" on the "master" branch? As if cheats sheets were a new feature of the next edition?

I'm at a point with ORCCA where we want to get serious about managing editions. My thinking is to start by making a tag for the just-completed "edition gamma" (the third edition from our pilot/construction year; the real "edition 1.0" will be completed in the coming months and released well in time for next fall).

So I'd have a tag "edition-gamma". And there there will be two branches: one for smaller edits that we want to immediately apply to the eBook, and one for larger edits that go into the next edition. The second branch should always get any commits that go into the first branch. Have we settled on standard names for these branches? I'm not sure "master" and "develop" are the right names. Are we going with "master" and "edition"?

Something I ran into with this experiment last week was that I had forked the repository before the edition branch was created. I figured out that I could git fetch upstream and then git checkout edition and all was good, but perhaps that's not the only solution or even the best solution. I don't know that needing to get a branch from upstream is going to be a super common occurrence, but I could see it happening, particularly if collaborative development of new material is going on where someone creates a new branch that won't be merged into edition for a while.