search

NCEAS / sasap-training

Training agendas and materials for open science tools for SASAP
https://nceas.github.io/sasap-training
8 stars 6 forks source link

Build Branching #11

Closed jkibele closed 6 years ago

jkibele commented 6 years ago

First, make a Juneau branch for existing version. Then make an anchorage branch (ANC_WDAFS_2018). Modify build script in each branch to build off of the current branch.

jkibele commented 6 years ago

We need to know if we want all available versions (Juneau and Anc_2018 so far) listed under "materials" on the website or just the most current one. Jeanette is discussing this with Matt, right @jeanetteclark ?

jeanetteclark commented 6 years ago

okay I'm going to make a call here - let's only have one link for materials but that should be built from the head of the master branch (so no changes in the build script)

Let's retain the Anchorage branch, and update that in the coming weeks with whatever changes we would like to make. Just before the training we can merge the Anchorage branch into master (and tag it). That way the production build isn't building our edits as we go.

Sound reasonable @mbjones?

jkibele commented 6 years ago

That seems reasonable to me too. ...The website changes a bit with each session (Juneau vs Anc, etc) so it seems less confusing to only have one item in materials, right?

But on the other hand, if someone then wants to get the old version of the book, they have to clone the repo and run the build themselves. That's no good is it? So, now that I think of it, I think we should add a "Previous Versions" section to the materials page. For Anchorage, that will just list the Juneau one. Then later it will list Anchorage and Juneau. and so on.

So, yeah, this will require a change to the build script. ...and maybe this is what @mbjones had in mind the whole time? It's making sense to me now. ...I think.

jeanetteclark commented 6 years ago

My thought is that if the changes are small (reflecting mainly instructor style, as opposed to content) we may not need previous versions. But I can see the benefit to both.

jkibele commented 6 years ago

So, we decided that one version of the materials was enough. We made a branch, but we keep merging it into master to make travis build everything, so probably didn't really need to do that.

amoeba commented 6 years ago

Just coming onto this thread way late:

@jkibele wrote:

But on the other hand, if someone then wants to get the old version of the book, they have to clone the repo and run the build themselves.

I think it'd be nice to have a fully built version of each book (Material) archived somewhere and linked from the training website.

@jeanetteclark wrote:

My thought is that if the changes are small (reflecting mainly instructor style, as opposed to content) we may not need previous versions. But I can see the benefit to both.

It seems like who instructs is really separate from who authored each module. Does anyone see a nice way we could indicate both roles? Or remove them altogether? Credit > nocredit though.