Add getready callout #141
Add getready callout #141
Conversation
iglpdc
force-pushed
the
add-getready-callout
branch
from
7511c16 to
5dd68e1
Compare
|
@ChristinaLK @r-gaia-cs this is how the "getready" callout would work for a lesson that needs some preparation steps. |
Our lesson tempate says that data files should be in a "data" directory. The name "filesystem" is not used in the lesson, so we are free to change it. This also allows to create a script at the lesson-template level to zip this data easily across different lessons and make them available throught the .getready callout.
iglpdc
force-pushed
the
add-getready-callout
branch
from
5dd68e1 to
e64c8de
Compare
| > 4. You can access this folder from the Unix shell with: | ||
| > | ||
| > ~~~ {.input} | ||
| > $ cd && cd Desktop/shell-novice/data |
There was a problem hiding this comment.
This will work for GNU/Linux distributions but I'm not sure if it will also work for Mac OS X and Windows with Git Bash.
There was a problem hiding this comment.
You mean the cd && cd Desktop?
If so, yes, it works in the 3 OS we use, and AFAIK is the only consistent way to do it.
There was a problem hiding this comment.
I mean if the directory Desktop exists at that location.
There was a problem hiding this comment.
+> 4. You can access this folder from the Unix shell with:
+>
+> ~~~ {.input}
+> $ cd && cd Desktop/shell-novice/data
I mean if the directory Desktop exists at that location.
It does for MacOS and git-bash on Win. Never tried for Linux, but you say so.
|
@iglpdc Thanks a lot for your amazing job with the Git and Shell lesson. |
|
I made a previous PR to change the Question for @iglpdc : if we ever change the data files (at some point), I assume the zip will have to be updated manually - it's not automatically created via the makefile? |
|
@ChristinaLK I think the best place to take care of this at the level of lesson-template, because pretty much all our lessons require extra files. I said in this issue in the python lesson that we could have a post-commit hook or something fancy, but maybe just an extra line to the Makefile would do it. So when we generate the html with |
update zip files. This enhancement grew out of [issue 94](swcarpentry/python-novice-inflammation#94 (comment)) in the python-novice-inflammation repository and the discussion in a [shell-novice PR](swcarpentry/shell-novice#141). It creates a maintainer_hooks directory in the tools directory. Lesson maintainers can use these hooks by symlinking to them in the .git/hooks directory. The pre-commit hook sets a "flag" file called .commit and the post-commit hook detects the presence of this flag and regenerates HTML and updates the data zip file if necessary. It then amends the previous commit by adding these files to the commit and keeping the same message.
update zip files. This enhancement grew out of [issue 94](swcarpentry/python-novice-inflammation#94) in the python-novice-inflammation repository and the discussion in a [shell-novice PR](swcarpentry/shell-novice#141). It creates a maintainer_hooks directory in the tools directory. Lesson maintainers can use these hooks by symlinking to them in the .git/hooks directory. The pre-commit hook sets a "flag" file called .commit and the post-commit hook detects the presence of this flag and regenerates HTML and updates the data zip file if necessary. It then amends the previous commit by adding these files to the commit and keeping the same message.
Which landed in swcarpentry/shell-novice#141.
Which landed in swcarpentry/shell-novice#141.
Which landed in swcarpentry/shell-novice#141.
This PR in lesson-example add a "getready" callout box in the
index.mdthat can be used to provide the learners with instructions on "what they should do to follow the lessons".The PR here add the callout box. I've also changed the name of the folder containing Nelle's filesystem from "filesystem" to "data" and make a zip file of it linked in the callout box.