cssbristol / cssbristol.co.uk

Source code for the UoB Computer Science Society web portal
MIT License
12 stars 25 forks source link

Updated Git tutorial to new version. #61

Closed bristol-d closed 5 years ago

bristol-d commented 5 years ago

Not sure what the convention is for image files related to a tutorial: I've put them in a subfolder for now.

danjones1618 commented 5 years ago

As part of the process of fixing the tutorials page I'm planning to introduce tutorial topics which would contain several different tutorials around the topics. One such topic I am passionate about is the use of git and the tutorial you've proposed is an excellent introduction to git!

I would also like to introduce topics such as how to properly name commits and the lesser known but important commands such as git mv, cryptographically signing commits, and the use of the Swiss army knife that is git checkout

I think there should be a section just after installing git to talk about how to configure git from the command line with git config --global user.name "John Smith" and git config --global user.email jsmith@example.com so that commits pushed to github are correctly associated with their github account

I'll hope to merge the tutorial as is over the weekend once I've adjusted the current tutorials page and may split up this tutorial into smaller pages such as "what is git and install", "git by yourself", and "git as a team" etc. so that the page isn't too long.

bristol-d commented 5 years ago

I'm fine with splitting it over pages - in the original version I had a new page start wherever I've put a h2 tag. I'm happy for you to make any changes you want.

If there's something like an 'info' block in the kind of markdown used on the website, I thought of putting one of those blocks in every section/page that shows the command-line instructions, then I could easily put the bit about configuring in the section on setting up.

danjones1618 commented 5 years ago

Merged with thanks. Will look into the info block idea and split into sections later.