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

Improving the setup page #781

Madchild95 opened this issue Feb 16, 2021 · 3 comments

Improving the setup page #781

Madchild95 opened this issue Feb 16, 2021 · 3 comments
good first issue Good issue for first-time contributors help wanted Looking for Contributors


Copy link

Hello community

I have made a proof reading of the Git novice lesson and thought I would make a comment on the setup page. I think the issue has already been discussed in here: #735, but I wanted to make a suggestion for how to make it a bit better, while still keeping the link for the general setup page (as I gathered that it was important to keep the setup page for the lesson and the instruction page for the setup separate).

As of now the current setup page looks like this:
Screenshot 2021-02-16 at 11 34 31

Issue: Personally, the first thing I would gather from this page is that setup for this lesson is just to have the Desktop as working directory in the terminal. Whereas the setup that really matters, namely to install Git and GitHub is sort of in the background and just mentioned in one sentence with a hyperlink.

Solution: My suggestion is to make a heading that says "Installing Git and creating GitHub account" much like in other lessons such as the Plotting and Programming with Python setup page:
Screenshot 2021-02-16 at 11 45 23

An explanation in this section could include an introduction text like the one on the general setup page:
"Git is a version control system that lets you track who made changes to what when and has options for easily updating a shared or public version of your code on You will need a supported web browser.

You will need an account at for parts of the Git lesson. Basic GitHub accounts are free. We encourage you to create a GitHub account if you don't have one already. Please consider what personal information you'd like to reveal. For example, you may want to review these instructions for keeping your email address private provided at GitHub."

And then additional information about how to navigate in the general setup page as a warning, something like:
"To setup Git and GitHub, you will need to go to our general setup page here, where there will be an instruction video on how to do so. You can choose which operating system (OS) you are working on (Mac, Windows, Linux) to install it correctly. The hyperlink will take you directly to the Git setup, but there will also be other setup instructions on this page, that you can ignore if you are just going to setup for this lesson. Whenever finished with the video setup you should be able pursue with this lesson in you terminal."

Then another subheading could have the title "Unix Shell" with the instruction text:
"Navigate to Unix Shell (see this setup page if you haven't installed Unix Shell already) where the code for this lesson will be written."

And then the rest of the page could follow as it is already with the description:
"We’ll do our work in the Desktop folder so make sure you change your working directory to it with:"
followed by the output from Bash.

I hope this makes sense and is clear, otherwise feel free to ask for any elaboration!

/Matilde Jacobsen

Copy link

kekoziar commented Jul 2, 2021

Hi, @Madchild95. A few headers would improve the readability of the page. However, I am in the "keep the install instructions in one place so we only need to update that one place" camp. IMO, it's easier on all maintainers, workshop instructors/admins, and learners. I especially think it's important to have the install instructions in one place for learners to get ready for their workshop.

Feel free to submit a PR with headers to improve readability.

@kekoziar kekoziar added good first issue Good issue for first-time contributors help wanted Looking for Contributors labels Jul 23, 2021
Copy link

Here is a suggested change that adds headers: #842

Copy link

wdconinc commented Apr 2, 2022

Increased visibility of the Git installation instruction with headers:
The links to different operating systems are all exactly the same and only serve to give visual weight and ensure the learners understand there are specific instructions for each operating system. Further discussion in PR #872.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
good first issue Good issue for first-time contributors help wanted Looking for Contributors
None yet

No branches or pull requests

4 participants