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

preparation of cli chapter #51

Closed
16 of 28 tasks
lnnrtwttkhn opened this issue Oct 23, 2023 · 5 comments · Fixed by #52
Closed
16 of 28 tasks

preparation of cli chapter #51

lnnrtwttkhn opened this issue Oct 23, 2023 · 5 comments · Fixed by #52
Assignees

Comments

@lnnrtwttkhn
Copy link
Owner

lnnrtwttkhn commented Oct 23, 2023

align the layout of the various chapters

  • move "acknowledgements" section to the bottom and rename to "acknowledgements & further reading"
  • move the cheatsheet to the bottom
  • "command-line" when used as an adjective, "command line" when used as a noun (see here)
  • "Git" instead of "git" throughout, see Unify casing in subsections to capitalize only first #37
  • add "prerequisites" to all the chapters, linking to previous chapters, as applicable
  • add {{< fa eye >}} to hidden outputs
  • add to beginning of chapter that readers are encouraged to type the command into the terminal instead of just reading.
  • add memes! students love memes!

add content

  • add a bit more "computer history" about the command line, making clear that this was for some time the main way to interact with a computer
  • add cc-by (or similar licensed) images of the CLI to the beginning of the chapter. maybe a GIF?
  • I think the difference between cli, terminal and shell is not yet super clear. maybe we can expand on this a bit. low-priority.
  • but based on that we should decide whether / when to use which term and clarify this explicitly
  • add instructions for mac, how to find out which OS version the computer runs
  • add juypterhub instructions for the terminal, ideally with screenshots
  • explain difference between bash and zsh

To verify if your machine is configured to use a shell other than Bash, you can type echo $SHELL in your Terminal window.

  • explain what the output of this ☝️ means
  • "navigating the file system": add more introduction text that explains how most users are familiar with navigating the file system through a GUI (e.g., Finder on Mac) using their mouse or arrows keys on the keyboard. we can do the same thing using the command line.
  • maybe add pictures that show what the same command or operation looks like in the finder
  • add explanation what is meant by "working directory"
  • add more explanation what hidden files are and why they are hidden
  • add a short warning that people should think about where they want to create new directories etc., e.g., on their Desktop and consider deleting it afterwards to not get confused.
  • add warning that files that are removed using rm are removed entirely and can not be retrieved from the bin! but please check that information again.

add to the terminology section

  • what is a "file"
  • what is a "folder"
  • what is a "directory"

general todos:

  • try out "git bash" on windows
  • explore jupyterhub
  • add recommendation to use tree command (see here) when viewing files and folders
@lnnrtwttkhn
Copy link
Owner Author

lnnrtwttkhn commented Oct 23, 2023

@konradpa, feel free to work on the cli branch that I just pushed (see e3edfc3), directly and we will merge to main later this week. thanks!

@lnnrtwttkhn
Copy link
Owner Author

already opened the PR in #52, we can also discuss there if needed. thanks!

@lnnrtwttkhn
Copy link
Owner Author

lnnrtwttkhn commented Oct 26, 2023

  •  replace screenshot of jupyterhub launch window with less browser tabs open.

@lnnrtwttkhn
Copy link
Owner Author

add gif to another place then a callout box (does not work ...?)

!["Definitely not lazy" by [CommitStrip](https://www.commitstrip.com/en/?) ([Source](https://www.commitstrip.com/en/2017/02/28/definitely-not-lazy/?))](../static/definitely-not-lazy-commit-strip.gif)

lnnrtwttkhn added a commit that referenced this issue Oct 26, 2023
* a few edits throughout cli chapter, see #51

* fix casing

* add encouragement of typing commands

* add intro to navigation section

* add section about hidden files

* add warning about rm command

* add note about creating directories

* add terminology

* add meme

* add instruction for finding macos version

* add explanation about bash vs zsh

* add explanation for echo $SHELL

* add jupyterhub instructions

* fix typo

* actually fix typos

* minor improvements

* add note about command history

* add installation guide for gitforwindows

* minor fix

* minor edits throughout

---------

Co-authored-by: konni0000 <[email protected]>
Co-authored-by: konradpa <[email protected]>
@lnnrtwttkhn
Copy link
Owner Author

@konradpa, #52 closed this, but could you put all open points into a new issue to keep in the "icebox" for later? thanks!

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 a pull request may close this issue.

2 participants