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

01-intro-BH-Contribution.md #1354

Closed

Conversation

BennettHenzeler
Copy link

Kia Ora Team,

Tena koutou me nga manaakitanga !

Here is my contribution to the carpentry training. Based on my experience in workshops, I think we should explain the basics of shell, which begins with "pwd" (directory) and moves to "cd" (navigating a directory) and then "ls" ( listing items within a directory). That was easier to understand for students. Hope this does not conflict with the team. Looking forward to receiving a positive response

Cheers

Bennett Henzeler

Instructions

Thanks for contributing! ❤️

If this contribution is for instructor training, please email the link to this contribution to
checkout@carpentries.org so we can record your progress. You've completed your contribution
step for instructor checkout by submitting this contribution!

Keep in mind that lesson maintainers are volunteers and it may take them some time to
respond to your contribution. Although not all contributions can be incorporated into the lesson
materials, we appreciate your time and effort to improve the curriculum. If you have any questions
about the lesson maintenance process or would like to volunteer your time as a contribution
reviewer, please contact The Carpentries Team at team@carpentries.org.

You may delete these instructions from your comment.

- The Carpentries

Kia Ora Team,

Tena koutou me nga manaakitanga !

Here is my contribution to the carpentry training. Based on my experience in workshops, I think we should explain the basics of shell, which begins with "pwd" (directory) and moves to "cd" (navigating a directory) and then "ls" ( listing items within a directory). That was easier to understand for students. Hope this does not conflict with the team. Looking forward to receiving a positive response 

Cheers

Bennett Henzeler
@bkmgit
Copy link
Contributor

bkmgit commented Jan 12, 2023

Thanks for your contribution. Examining it.

@bkmgit
Copy link
Contributor

bkmgit commented Jan 27, 2023

Thanks for the pull request. It fails to build because

./_episodes/01-intro.md: Line(s) too long: 94, 96, 101
./_episodes/01-intro.md:108: Unknown or missing code block type None
./_episodes/01-intro.md:114: Unknown or missing blockquote type output callout

Comment on lines -114 to +119
> $ ks
> $ PWD
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an example of a typo creating an error, so would leave as is.

Comment on lines -104 to +109
Desktop Downloads Movies Pictures
Documents Library Music Public
/Users/Desktop/Bash/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to use pwd instead of ls.

Comment on lines -93 to +101
You may have seen it in a text editor program, for example.

So let's try our first command, `ls` which is short for listing.
This command will list the contents of the current directory:
In order to clear up any confusion, let's define the one major terms that you will use differently from your GUI in shell. "Folders" and places where your files are located are called "directories". Assume you have a text file named **"Data.txt"** inside a folder **X**, which is within a folder **Y**. Accessing the word file requires entering folders **Y** and **X**.

Visually, your text file is in the last box, but to access it, you need to open the other boxes first.

![81MROYPRGXL](https://user-images.githubusercontent.com/59741732/206088542-bb144e91-d3e9-402a-8643-b3f6a5a8979f.jpg)

So let's try our first command, `pwd` which is short for print working directory.
You can use this command to print the directory where you are at that moment. From which you can navigate forwards or backwards
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image is nice, but most lessons are taught without displaying figures, instead attendees type along. Using ls rather than pwd is a better starting point. pwd is introduced in the next section.

@bkmgit
Copy link
Contributor

bkmgit commented Jan 27, 2023

The introduction is short. ls is used as the first command, but pwd is introduced shortly thereafter. It maybe better to use another command than ls, but pwd would require restructuring the next section. Maybe the questions in the overview in https://swcarpentry.github.io/shell-novice/02-filedir/index.html should be updated so that attendees have a better idea of how things fit together? At the moment

Questions

  • How can I move around on my computer? cd
  • How can I see what files and directories I have? ls
  • How can I specify the location of a file or directory on my computer?

To

Questions

  • Where am I? pwd
  • How can I find or specify the location of a file or directory on my computer?
  • How can I see what files and directories I have? ls
  • How can I move around on my computer? cd

@gcapes
Copy link
Contributor

gcapes commented Jan 27, 2023

Perhaps you can split your suggestion out into a separate issue and close this PR? @bkmgit

@bkmgit
Copy link
Contributor

bkmgit commented Jan 27, 2023

@BennettHenzeler Thanks for your contribution. Let me know if the suggested changes would help address your concerns. Can implement them, but your feedback would also be appreciated.

@bkmgit
Copy link
Contributor

bkmgit commented Apr 19, 2023

Created related issue #1380

@bkmgit bkmgit closed this Apr 19, 2023
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

Successfully merging this pull request may close these issues.

3 participants