carpentries / styles Goto Github PK

I would like to use http://csscomb.com to ensure one code style.

The configuration that I like to use is

{
    "remove-empty-rulesets": true,
    "always-semicolon": true,
    "color-case": "lower",
    "block-indent": "  ",
    "color-shorthand": false,
    "element-case": "lower",
    "eof-newline": false,
    "leading-zero": true,
    "quotes": "single",
    "sort-order-fallback": "abc",
    "space-before-colon": "",
    "space-after-colon": " ",
    "space-before-combinator": " ",
    "space-after-combinator": " ",
    "space-between-declarations": "\n",
    "space-before-opening-brace": "\n",
    "space-after-opening-brace": "\n",
    "space-after-selector-delimiter": "\n",
    "space-before-selector-delimiter": "",
    "space-before-closing-brace": "\n",
    "strip-spaces": true,
    "tab-size": true,
    "unitless-zero": true,
    "vendor-prefix-align": true
}

See:

• swcarpentry/DEPRECATED-lesson-template#112
• swcarpentry/DEPRECATED-lesson-template#229
• swcarpentry/DEPRECATED-lesson-template#253

I think perhaps the in-line code segments would stand-out more if they had a background, like the classic github style.

Like here

AUTHORS is not a Markdown file, and so is not checked for.

Coffee breaks and lunches don't have the same metadata as lesson episodes.

Was originally swcarpentry/DEPRECATED-lesson-template#293 - please see that issue for discussion.

How would people feel about numbering the lessons in the schedule? I personally like to be able to say things like "we will be covering up to lesson number x today" during workshops.

Lessons currently use 09:00 as a start time for the schedule - @jduckles suggests using 00:00 (to show elapsed time). This makes sense for half-day lessons, but it's helpful with full-day lessons to show where the lunch break comes (12:00 is more easily understood than 03:00). Preferences?

By default, max-width is not set for images, so they all render in original size.

Links should be exactly one of:

• [title][footer-tag-to-external-URL]
• [title]({{ site.root }}/something)
• [title](#local-label)

Hi,
I have some suggestions on the template for the SQL lessons:

Padding:
*I see that most if not all tables need a bit more of bottom padding, the letters in the next paragraph are too close.
*Challenges on the other side are very spacious in between, and probably the question title should be a bit smaller.
Colors:
*Table headers, I don't know if it is just me, but that blue is too dark to be combined with black... just saying...

This is a duplicate from:
swcarpentry/sql-novice-survey#27
suggested by Raniere Silva to be copied here.

We need to check that all the packages required by a lesson, and this check should probably live in this repository so the code is consistent across lessons that use R packages.

The problem is that, a priori, this repository doesn't know which package a lesson will need. I can think of a couple of approaches:

1. We hard code in this repository all packages used across lessons based on R. Probably the easiest, but not very practical, as adding a new package dependency in a lesson requires a pull request here, and merging the changes back in the lesson repository.
2. We create a file within each repository that lists the packages the lesson uses (à la DESCRIPTION). A script in the styles repository would parse this file and check that the packages are available.
3. We use a per lesson approach and let maintainers make the appropriate modifications to the code in their lessons to make sure that the packages their lessons rely on are available.

I think 2 is my preferred option. Any thoughts or better solution @naupaka, @noamross, @gvwilson?

the CSS that determines the position of the github ribbon needs to be updated as it clashes with the newer version of bootstrap, and it's a little too far to the right.

See carpentries/workshop-template#177 for original discussion.

The links in the footer to the repository and the contribution guide are incorrect when previewing material locally.

Perhaps worth adding a check for python version? Not a python guru myself so not sure best way to handle this. Or maybe I just missed something somewhere. But it looks like a python 3 print() call is gumming things up.

Noticed because make lesson-check was failing for me.

make lesson-check                                                                                   
Traceback (most recent call last):
  File "bin/lesson_check.py", line 14, in <module>
    from util import Reporter, read_markdown, load_yaml, check_unwanted_files, require, IMAGE_FILE_SUFFIX
  File "/Users/naupaka/git/Software_Carpentry/r-novice-gapminder/bin/util.py", line 10
    print('Unable to import YAML module: please install PyYAML', file=sys.stderr)
                                                                     ^
SyntaxError: invalid syntax
make: *** [lesson-check] Error 1

Isolated to the script:

python bin/util.py                                                                                  
  File "bin/util.py", line 10
    print('Unable to import YAML module: please install PyYAML', file=sys.stderr)
                                                                     ^
SyntaxError: invalid syntax

No problem with python3.

python3 bin/util.py
<<no output>>

Originated as swcarpentry/DEPRECATED-lesson-template#288 - we need to document its use here or in the lesson example.

Authors should be allowed to use back quotes and emphasis in questions, objectives, etc.

It will make error reporting more consistent...

Create some sort of single-file display of all images for instructors to use in class. Was originally swcarpentry/DEPRECATED-lesson-template#265.

Was originally swcarpentry/DEPRECATED-lesson-template#277.

Similar to that used in O'Reilly books and others. (Was originally swcarpentry/DEPRECATED-lesson-template#250.)

@gvwilson Do you want the history of CSS from lesson-template preserved?

Isn't clear what is the caption and the text.

Need a layout for

$ pandoc <<EOF
![foo](bar.jpg)  
heredoc> EOF
<div class="figure">
<img src="bar.jpg" alt="foo" />
<p class="caption">foo</p>
</div>

that are compatible with

$ pandoc -t html5 <<EOF
![foo](bar.jpg)
EOF
<figure>
<img src="bar.jpg" alt="foo" /><figcaption>foo</figcaption>
</figure>

1. Add script to be used by Travis-CI to check correctness of lessons' Markdown.
2. Modify bin/lesson_check.py so that it only reports unexpected images in check-all mode (so that extra images don't trigger a build failure).

Originated as swcarpentry/DEPRECATED-lesson-template#252 - need some way to generate a single HTML page/PDF file with everything in it, including correctly-resolving links. Order within that single page should respect the order in the navbar menu.

Document how to create a ZIP file of auxiliary files needed by learners and where to store it. Was originally swcarpentry/DEPRECATED-lesson-template#268.

Since we are using Bootstrap maybe we could compile our own version of the CSS so it will be small and also include our customization.

@wking What do you think of this?

So that mentions in text can link to glossary. May require modifications to Jekyll.

Following @wking's suggestion in carpentries/workshop-template#152, it seems that we need to discuss whether the SWC logos should be included in this repository.

Currently, the workshop template gets the logo from software-carpentry.org, while the logo is included in the repository for lesson templates and the main website.

Having them in a single location would limit duplication, allow for offline rendering of the workshop templates, and facilitates serving over https. If we decide to go this way, we will probably need to create a new directory that will only contain images shared across all sites.

The intermediate R files should not be deleted by make clean, since they have to be committed to the repository for GitHub Pages to work.

Output of reporter is currently sorted textually, so filename:100 comes before filename:2.

Was originally swcarpentry/DEPRECATED-lesson-template#278.

Lesson checking tool should check that all_figures.html is up to date.

Originated as swcarpentry/DEPRECATED-lesson-template#298

@orchid00 recommends prev/next links at the bottom of lesson episodes as well as the top. My attempts to style this have all been exceptionally ugly - a PR would be welcome. (You can test your PR by making changes in a local copy of https://github.com/swcarpentry/lesson-example and previewing with make serve (or pushing to your own gh-pages branch).)

@gvwilson README will conflict when pulling this repo from site, workshops and lessons. Could we remove it from the history?

We want that space bar and backspace keys to work like left and right. This problem was reported at swcarpentry/slideshows#22 and this feature was already implemented upstream, imakewebthings/deck.js#179.

@twitwi could you help us with that?

Originated as swcarpentry/DEPRECATED-lesson-template#130 - the checking tools should make sure that the right remotes are set up with the right names.

From https://github.com/swcarpentry/git-novice/blob/gh-pages/01-backup.md