-
Notifications
You must be signed in to change notification settings - Fork 1
Drafted first half of the tutorial #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Hallo hallo! Back from being stuck in Sweden for an extra day and on this again. If it makes sense, I'll review this PR first as it is, and then look at @estramcar 's PR (#5) to see when we should merge that in here. Let's treat this as a mid-way review and aim to put things together to see how they look. @alesssia , thank you for the detailed PR description here 👌 . If you don't mind, I'm going to rejig the formatting of the description a bit so we make sure all your concerns are addressed! |
|
@alesssia , I've had a quick skim, and first of all, I like your division of the tasks into these sections. It will make comprehension and the wrap-up a lot easier. The descriptions are also very clear - and this is a strange thing to say, but perhaps a little too clear in places, e.g. describing exactly where to look for things. There are two reasons for my saying this:
It might detract from the neat work you've done with sections, which I think will play a big part in enabling them to summarise what a good collaboration process looks like, and overall that the same principles apply should they decide to use Bitbucket, Github Desktop, or Git command line instead. I think it might be clearer to see how to trim the text if you have @estramcar 's images in here (or where images can be improved or added!). Do you think we should merge them in? And testing/previewing - any instructions on running this locally at least to check it out? :) |
|
@feiphoon happy to make it less detailed, just believed that since we had screenshots we could explain where things were as well. I can drop these, and send an updated pull request. @estramcar what is your opinion? I will do a fork since it is the main way you have to collaborate in the real world (being a collaborator is rare, at least in my experience). @estramcar ? Testing: I was doing things while writing, therefore it should work. Anyone wants to create a test repository and play around? |
|
I will do a fork since it is the main way you have to collaborate in the real world (being a collaborator is rare, at least in my experience).
Actually, developers in an organisation don't fork, they use direct push
access, even to a repo of considerable size 🙂There is also the git-flow
method of collaboration too. I think forking is probably most common with
open source.
ETA: I think the above is good to mention in the talk though, so here's a note to myself to add it to the wrap-up.
|
| --- | ||
|
|
||
|
|
||
| ## Step 1. Forking the repository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought we had decided not to talk about forks?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I forgot 😊 , but how do you do a direct push in the GitHub UI?
Ok, we said "Everyone creates a branch to address their assigned issue" so everyone creates a branch on the "original" repo, right? @feiphoon @estramcar ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes :)
|
I've had a quick look at running Jekyll locally. My personal machine is at home so I'll try it tonight. But based on this: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#step-2-install-jekyll-using-bundler
|
|
Ok, ladies, since @estramcar is having issues with the forked repo I am closing this pull request and pushing directly. However, since Jekyll projects page live on the gh-pages branches, there will be no need of a pull request (and also this one is somehow misplaced, my bad).
|
|
@alesssia yes, we are on the same page about what forking is for :) But what we are teaching is a universally-accepted collaboration process with Git, and one that can be practised on one's own or with others in both informal and formal settings. Forking can be easily explained as a modification on top of this process, but the other way round might be tricky. If they learn the basic process, they will be shown how to fork at a Python sprint. I will mention it though, so not ignoring ✌️ |
|
By the way, @alesssia & @estramcar , love how thorough we're being, thank you! I'm going to do as much as possible tonight and start filling in/editing. |
|
I'm gonna merge it to make continuing and the next review easier 🍅 |
|
That should not have been merged with I have cleaned master now (so you can also merge #9) but if we want to move to the second option ( |
Hi @feiphoon, and hi @estramcar,
I have drafted the first half of the tutorial, under a
gh-pagesbranch and exploiting the power of Jekyll (and a free theme). Hope this reflects what we have decided 😃.More in details, I have created 4 tasks our of 5 I believed fit, that are:
We could do the Checkpoint/timecheck at the end of task 4?
So far I worked up to task 4, now asking for a code review before moving to task 5 (so I can also play with this pull request and remember all the steps 😊 )
Here are the main points to check
In general:
index.mdsetting-up.mdissues.mdown-branch.md