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

A lesson on shell / bash setup - related to the dependency page PR #134

Open
lwasser opened this issue Dec 15, 2023 · 2 comments
Open

A lesson on shell / bash setup - related to the dependency page PR #134

lwasser opened this issue Dec 15, 2023 · 2 comments

Comments

@lwasser
Copy link
Member

lwasser commented Dec 15, 2023

In our guide - we spent a bit of time discussing users and various shells.
here is the conversation

in my experience teaching this topic, many don't know / understand bash / shell / windows terminal etc and as such this could become a stumbling block. It could be worth us having a page somewhere that helps users understand what shell they are using and associated setup items that they may need to consider.

tagging @ucodery and @sneakers-the-rat as they were heavily involved in this conversation as well as @Zeitsperre

@lwasser lwasser changed the title A lesson on shell / bash setup A lesson on shell / bash setup - related to the dependency page PR Dec 15, 2023
@sneakers-the-rat
Copy link
Contributor

This is where we start getting into wiki territory :) so ideally it would be easy for us to drop in pages for lots of different topics as they come up. In wikis this is done with wikilinks, but in Sphinx style docs this could be maybe more like using the index directive - the places where eg. Shells are mentioned go into the index, and then we can manage links between places in guides where topics are mentioned and longer dedicated pages for those topics.

One of the reasons wikis are great is they really lower the barrier to making additions like this, so we might think of having an adjoining wiki for extra topics like these so we can just make pages as-needed :). But in any case I feel like for now another document thats more like "environment management and DX" stuff would be great - IDEs and the practicalities of interacting with code are a huge grey space in documentation, as I am learning again when teaching a student from scratch.

I dont feel like we should try and document the whole universe (but we can try!) So even something as little as gathering links out to other resources by topic would be great pending a Fuller docs push

@ucodery
Copy link
Collaborator

ucodery commented Dec 16, 2023

I agree that a fair amount of our readers likely won't know what shell they're using, or what a shell is (or a terminal, pty). It would be nice to have a page to introduce them, or to at least let them answer the question. But this also seems pretty far afield from packaging.

This reminds me that I once saw @[email protected] state that the best way to determine the currently-running shell was to execute a nonsense command (like this-will-never-work-its-not-a-command) and then read the error message, as most shells report their name in the error message.

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

3 participants