Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 3.42 KB

FAQ.md

File metadata and controls

87 lines (60 loc) · 3.42 KB
Raw

FAQ

  • Where can I get help?

    Mail [email protected], or join our discussion list and ask for help there.

  • Where can I report problems or suggest improvements?

    Please file an issue or mail us.

  • Why does the lesson repository have to be created from scratch? Why not fork lesson-template on GitHub?

    Because any particular user can only have one fork of a repository, but instructors frequently need to work on several workshops at once.

  • Why use Pandoc? Why not some other markup language and some other converter?

    Because it supports a richer dialect of Markdown than Jekyll (the converter that GitHub uses by default). In particular, Pandoc can do tables and allows us to add styles to headings.

  • What do the labels mean?

    • bug: something is wrong in our tools or documentation
    • defer: marks an issue that we will work on, but not now
    • discussion: marks issues used for conversations about specific problems and questions
    • duplicate: marks an issue that was closed as redundant (include the number of the original issue in the closing comment)
    • enhancement: asks for, or adds, a new feature or new information
    • filed-by-newcomer: issue or pull request was filed by someone who is relatively new to GitHub and/or this project, and would appreciate guidance as well as feedback
    • getting-started: issue or pull request is suitable for someone new to GitHub and/or this project
    • help-wanted: a question or request for assistance
    • left-as-was: marks an issue closed because the item in question will be left as it was
    • suitable-for-newcomer: issue or pull request is a good starting point for someone who is relatively new to GitHub and/or this project
    • work-in-progress: a pull request that is not yet ready for review

  • How can we create input cells for particular languages?

    Use

    ~~~ {.lang}
some code
~~~

    where lang is bash for the Unix Shell, r for R, matlab for MATLAB, python for Python, and sql for SQL. For a full list, check:

    $ pandoc -v

Debugging

Please add notes about problems and solutions below.

  • pandoc: command not found

    You probably don't have Pandoc installed.

  • pandoc: Error running filter tools/filters/blockquote2div.py due to ImportError: No module named 'pandocfilters'

    You probably haven't installed pandocfilters.

  • pandoc: Error running filter tools/filters/blockquote2div.py tools/filters/blockquote2div.py not found in path

    Git has likely checked out the files with the incorrect line endings. On Unix systems the recommended setting is:

    git config --global core.autocrlf input

    and on Windows:

    git config --global core.autocrlf true

    Note that after changing this setting you will need to either re-clone or re-checkout the files in the repository.