Skip to content

Conversation

@feiphoon
Copy link
Owner

@feiphoon feiphoon commented Feb 20, 2019

A work in progress, but opening now to keep my team in the loop.

Todo:

  • Consider Tutorial screenshots #5 & Drafted first half of the tutorial #6 again to make further content more harmonious
  • Add images (need an image folder)
  • Generate & upload PDF
  • Upload final version to speakerdeck, ready for workshop
  • Simple instructions for Marp (Nice to have)
  • Add speaker notes using HTML comments <!-- Speaker notes test -->

To preview this in the absence of the generated PDF, either check it in a markdown previewer (and Atom has a package), or download Marp (https://yhatt.github.io/marp/) and open file in it.

Update: Available here for its near-final form https://speakerdeck.com/monkeyfruit/github-for-collaborative-datasci-and-dataeng

feiphoon and others added 3 commits February 14, 2019 18:02
(Can't create an empty folder on Github, must have a file in it)
Middle section WIP, need to consider the tasks again;examples missing, but I have them!
@alesssia
Copy link
Collaborator

Hi @feiphoon, the content seems good to me, just not sure whether we should introduce Gist.

@feiphoon
Copy link
Owner Author

feiphoon commented Feb 21, 2019

At this point, feeling the flow much better. A couple of WIP slides remaining with fragments (marked with a +++++). I am toying with the idea of verbally reiterating our occupations at Question Time so people can ask directed questions.

ETA: Self-criticism, I obviously want to keep it a secret from everyone that Git is a version control system :P To-do!

@feiphoon feiphoon self-assigned this Feb 21, 2019
- Merge
1. **Repository:** a project.
2. **Branch:** a collection of changes.
3. **Master:** the "default" branch, also the most recent, fully-approved version of the project.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Shall we give them an idea of how a good project is set up? I mean master branch, release branch, develop branch, fix branches, ...

Copy link
Collaborator

@Ester-Ramos Ester-Ramos Feb 21, 2019

Choose a reason for hiding this comment

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

I think we should keep it simple. That is the git flow process I use at kobalt, and it took me a while to get my head around it.

2. **Branch:** a collection of changes.
3. **Master:** the "default" branch, also the most recent, fully-approved version of the project.
4. **Commit:** a saved change on a branch. So branches are groups of changes with a common objective.
5. **Pull request (PR)**: a request to add your branch of changes to `master`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

You can't do a PR to a branch different from master?

Copy link
Owner Author

Choose a reason for hiding this comment

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

Of course! But let's keep it simple for beginners & head straight for our learning objectives - this will get them where they need to be. Delving into git branching is intermediate level.

3. **Master:** the "default" branch, also the most recent, fully-approved version of the project.
4. **Commit:** a saved change on a branch. So branches are groups of changes with a common objective.
5. **Pull request (PR)**: a request to add your branch of changes to `master`.
6. **Merge**: the action that accepts your branch into the master branch.
Copy link
Collaborator

Choose a reason for hiding this comment

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

As before, it cannot be just a generic that accepts your branch into another branch? Or a remote branch (but not sure if GH IU has concepts like local/remote.

Copy link
Owner Author

Choose a reason for hiding this comment

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

As before about branching :) We are using Github web UI because local/remote (as with push/pull/fetch) are additional concepts, and we cover that later.

---
# Workshop Time

See: https://github.com/feiphoon/github-workshop/
Copy link
Collaborator

Choose a reason for hiding this comment

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

Shall we link directly to the github.io project's pages?

Copy link
Owner Author

Choose a reason for hiding this comment

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

I think we should focus on getting an MVP out - we need time to show our support team/tutors what they need to revise, plus I have another project to finish before Sunday. There's no reason why the markdown files won't be fine to use as they are - they're formatted nicely and accessible. Can we leave the transfer to Pages as a last enhancement and a nice-to-have? Changing this link will be part of that.

@feiphoon
Copy link
Owner Author

feiphoon commented Feb 21, 2019 via email

@Ester-Ramos Ester-Ramos self-requested a review February 21, 2019 10:12
Copy link
Collaborator

@Ester-Ramos Ester-Ramos left a comment

Choose a reason for hiding this comment

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

I think it's good. We should merge this and make more changes later if needed.

slides/slides.md Outdated
###### *26/02/2019*

---
For Alessia, if you need a slide or two?
Copy link
Owner Author

Choose a reason for hiding this comment

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

@alesssia I made you a space if you need it!

Copy link
Owner Author

@feiphoon feiphoon left a comment

Choose a reason for hiding this comment

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

I'm done with my part! I intended to upload two versions - darker & lighter to compare, but it seems that the formatting on the lighter/basic template has failed (it gets even more shambolic after uploading to SpeakerDeck). I will probably delete it.

You can preview the presentation here: https://speakerdeck.com/monkeyfruit/github-for-collaborative-datasci-and-dataeng

@feiphoon
Copy link
Owner Author

@alesssia @estramcar I'm going to merge this to make it easier for @alesssia to branch off & catch up!

@feiphoon feiphoon merged commit f737aaf into master Feb 26, 2019
@feiphoon feiphoon deleted the presentation-notes branch February 26, 2019 09:52
@alesssia
Copy link
Collaborator

Too late, I had already branched out of presentation-notes before going to the dentist :)
Anyway, there will be no conflicts, asked to merge with master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants