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

Issue828 rearrangements in working with files #871

Conversation

schmeing
Copy link
Contributor

@schmeing schmeing commented Dec 4, 2018

Did part of what was suggested in Issue #828 "Suggested edit to a lesson"

I moved up the "Good names for files and directories" and "What’s in a name?" boxes. However, not completely up to the first sentence as I think it helps to visually see some examples and the ls -F command two lines after does exactly that.

The "Which Editor?" box I left untouched as I think it is overloading the students to put all that info before you are using it, so I left it right in front of the first use of the nano editor.

Probably the info box belonging to the key point was moved between episodes and the keypoint was forgotten
@colinmorris
Copy link
Contributor

Thanks for the PR (and sorry for the late response). Moving that key point from lesson 2 to 3 is definitely a great correction.

I'm ambivalent on rearranging the info boxes in this way though. I tend to think of content in the 'callout' boxes as optional or supplementary, so I think it makes sense to put them after the main content to which they're relevant. e.g. to have an example of creating a file or directory, then have a callout box with tips on naming style.

I'd be curious to hear other perspectives on this though.

@colinmorris colinmorris added the status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR label Jan 3, 2019
@gcapes
Copy link
Contributor

gcapes commented Jan 8, 2019

Thanks for the contribution @schmeing
I agree with @colinmorris that the current position of the callouts makes sense - in general the lessons do something first, then expand on it when the learner has something to 'hang' the new information on.

If everyone agrees, could you reset your branch so that the PR only includes commit 02296df. Do shout if you're unsure about the git side of things.

…into schmeing_issue828_rearrangements_in_working_with_files

Reverted commits 918d4ba and 0e7aa95
@schmeing
Copy link
Contributor Author

Reverted the 2 commits as asked during the merge with the base
I still think "What's in A Name" and "Good names for files and directories" belong together as they are both about how to name files and directories.
The advantage of having the "What's in A Name" at the same position where "Good names for files and directories" currently is, is that there are multiple examples of file endings and not just .txt shown in the ls.
The disadvantage is that it would be a huge chunk of additional information right there.

@gcapes
Copy link
Contributor

gcapes commented Jan 16, 2019

Thanks @schmeing.

I see no reason not to move the What's in a name callout into the Create a text file section. I don't think it should go right after the Good names for files and directories callout because it only refers to files, and at this point I think we need to be careful to avoid cognitive overload.

I have a large PR (#887) waiting review, which fixes several issues - I'll tag this suggestion onto that.

@gcapes
Copy link
Contributor

gcapes commented Jan 16, 2019

Reset and merged in f82338e

@gcapes gcapes closed this Jan 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:waiting for response Waiting for Contributor to respond to maintainers' comments or update PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants