Skip to content
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

We need documentation on how to change HTH #15

Open
merlijn-sebrechts opened this issue Jun 5, 2018 · 0 comments
Open

We need documentation on how to change HTH #15

merlijn-sebrechts opened this issue Jun 5, 2018 · 0 comments

Comments

@merlijn-sebrechts
Copy link
Member

merlijn-sebrechts commented Jun 5, 2018

We need documentation that describes how you can contribute to Hack the Hackerspace. Below is a proposal for the documentation.

What is Github?

Github is a website where people write text together. It's like a merge between Google Docs, Dropbox and Facebook.

Who uses Github?

A lot of IT companies and IT people. And some non-IT companies and people

Well, almost every software company. A lot of large software companies use Github to create open source software. Some examples:

A Github repository

A Github repository is an online folder which includes all previous versions of the files in the folder. As an example, this is the 0x20 Hack the Hackerspace repository. This image below shows some of the files in this repository.

image

When you click on a file, you see a preview of that file.

image

If you want to see all the previous versions of a file, click on it and click on the "history" button in the top right.

image

In a git repository, all changes to a file are recorded as "commits". Each commit has a name and a description which explains what has changed in that commit. Each commit also shows which user changed the file.

If you click on a name of a commit in the "history" screen, you see the changes for that specific commit.

image

  • Lines with a + in front of them are added by that commit.
  • Lines with a - in front of them are removed by that commit.
  • When a line is changed, it is shown as the old line being removed and the new line being added.

image

What is Markdown?

The text of Hack the Hackerspace is written in Markdown. Markdown is a format to write text files which can be easily converted to beautiful pdfs and web pages. All the text you can write on Github is markdown. This issue is written in Markdown and you can write your thoughts on this issue below using Markdown.

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

No branches or pull requests

1 participant