IAC - Version Control
GITHUB
GITHUB
  • Background
  • Setting up GitHub
  • Windows
    • Working with a cloned repo
    • Populating a repo from local files
    • Integrate VSCode
  • Linux
    • Using SSH
    • GH Command Line
  • The Basics
    • Forks
    • Logs
    • Undoing Local Changes
  • Larger Projects
    • Setting up a repo
    • Creating my Branch Architecture Locally
    • Creating a Feature Branch
    • Creating my Branch Architecture on GitHub
    • Merging the changes from GitHub on my local machine
    • Merging the changes from my local machine to GitHub
    • Sync the branches in GitHub
  • Finally
Powered by GitBook
On this page

Setting up GitHub

Go to GITHUB and create an account. As a student, you are entitled to a student toolkit and its FREE!

  1. You will need to verify your student account, there will be a CAPTCHA or similar test.

  2. You also need to verify using your e-mail address.

  3. Go through the hello-world activity and understand GIT’s terminology.

Many people create public repos, you can now search on any topic you are interested in. If you find a project you are interested in, you can watch, so you are updated when changes occur.

There is a marketplace, you can search this for commercial tools to improve your development work.

Add an avatar/picture; be polite!

Create an account on GitHub for this module, call it L12345678, where the name is your L number. include a description. Get it right, this is the only place you can submit some of your course work!

Note that everyone can now see this repo, do not create assignments here unless you secure them as private.

Create private repos called

  • Templates

  • DOS

  • Linux

  • Python

  • Project

  • PowerShell

  • Ansible

There are some options:

  • Add a README file

  • Add a .gitignore for Python files

  • Use the Creative Commons license

You will now see an interface which gives some instructions; mine is show below.

readme.md

Edit the readme.md file as you go along, someone browsing your repo should be able to understand the repo fully based on what is written here. Typical practice is to have headings on:

  1. Objective of the project, what problem the project will address.

  2. How users can get started with the project, dependencies, environment.

  3. Where users can get help with the project.

  4. Who maintains and contributes to the project. Do not post e-mail addresses.

  5. If there is major documentation in sections, you could link to it from here.

If its complicated, include a table of contents with links.

readme.md should be short, its a summary, not detail.

I am not a fan of badges, etc. but feel free to add.

PreviousBackgroundNextWindows

Last updated 4 months ago

You should be able to find this repo .

here