Skip to content

Clarify purpose and content of "Useful library GitHub repositories" #187

@alex-ball

Description

@alex-ball

How could the content be improved?

On the Reference page, there is a collection of links under the heading "Useful library GitHub repositories". There are several problems with this section:

  • While most of the links point to GitHub repositories, not all of them do:
    • pymarc is actually hosted on GitLab.
    • "umd-mith/git-intro", "Python Programming for Humanities" and "Opening Science" point to rendered resources, not the source code repository.
    • "Code4Lib 2008 lightning talk" has no obvious link to a Git repository.
  • Most entries don't explain what is useful about them, or why they are on the list. For example, the Python course is not related to Git or libraries, but illustrates what can be done with GitHub Pages.

I'm wondering whether the following steps would improve matters:

  1. Rename the section "Useful library-related Git repositories".
  2. Move "Code4Lib 2008 lightning talk" to "Further reading".
  3. Start each entry with a link to the GitHub/GitLab repository, and an explanation of why it is on the list: either its relevance to libraries or its relevance to the lesson, or both.
  4. For those entries that currently point to rendered resources, move the current link to a sub-list. (The pymarc entry uses this pattern.)

For example:

  • umd-mith/git-intro: Slides introducing Git, aimed at Digital Humanities students, hosted on GitHub pages
  • openingscience/book: The evolving guide on how the Web is changing research, collaboration and scholarly publishing, maintained as Markdown files and rendered using Jekyll (also used by GitHub pages)

Which part of the content does your suggestion apply to?

https://librarycarpentry.github.io/lc-git/reference.html#useful-library-github-repositories

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedLooking for Contributorstype:clarificationSuggest change for make lesson clearer

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions