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

Explaining the term "dependencies" #201

Open
jdamerow opened this issue Feb 2, 2023 · 1 comment
Open

Explaining the term "dependencies" #201

jdamerow opened this issue Feb 2, 2023 · 1 comment
Assignees

Comments

@jdamerow
Copy link

jdamerow commented Feb 2, 2023

I'm wondering if the term "dependencies" should be explained at the beginning of the lesson (https://carpentries-incubator.github.io/docker-introduction/introduction/index.html). It's used quite frequently throughout and issues with dependencies are a good reason to use containers, but someone who hasn't had too much experience with software development/programming might not really understand what the term refers to.

Maybe adding a note box that says something like "A dependency is a piece of software or programming module that another software depends on. For example, if you develop an application that uses a PostgreSQL database then PostgreSQL is a dependency of your application. You can't run your application if PostgreSQL does not run properly."

Maybe it's obvious but it seems like one of those terms that we think everybody understands because it has meaning, but that might not be obvious to people with less technical background. :)

@aturner-epcc
Copy link
Contributor

aturner-epcc commented Feb 2, 2023

I think this is a very good idea and ties into the review issue on adding a glossary. I think a callout box for this specific term (as it is used so much) and an entry in the glossary is the way to go.

Thanks for raising @jdamerow

@aturner-epcc aturner-epcc self-assigned this Feb 2, 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

No branches or pull requests

2 participants