necx-org/nodes

Holds teaching nodes for the Nuclear Engineering Curriculum Exchange (NECX)

nodes's Issues

Add dependency tree logic checker to CI

CI needs a checker that determines that the dependency tree logic for new nodes is correct. (Does the node have parents, for example... are those parents defined? undefined?)

Set up CI

CI needs to do a ton of things eventually (see below). For now, set up a CI instance for this repository so that the things below (each with their own issue) can be implemented eventually.

• Testing
  • Metadata checker
  • Dependency tree logic
  • Splle c hkjser
  • Pep8 checker
  • LaTeX build checker
• Deployment
  • Build jekyll website
  • Build d3.js dependency graph

Make CI build a nice looking d3.js dependency graph

like so: http://rosalind.info/problems/tree-view/

Find a good reference for what constitutes a learning objective

Find a good reference for what constitutes a learning objective. Include it in the guidance for contributors and reviewers.

Create d3-based node dependency visualization and make CI build it

Autogenerated and put on website.

Determine a list of converters and renderers

We talked about a bunch of formats that are used by learning/classroom management systems. We need to decide the first set of converters and renderers we attempt for the first release of this.

Develop a community consitution

Define some things about how NECX will operate:

• governance model
• code of conduct
• guiding philosophies and/or principles
• scope (?)

Travis CI build

I'm not really familiar with this. All of my pull requests fail on the Travis CI. Is there something I'm doing wrong or does the .travis file need configuring?

Add CC-By license

as title says

Set up file structure

Set up the basic file structure for this repository. Create a place for nodes, scripts, ci, docs, etc. Contemplate jekyll behavior.

Create a template node

Create a base case node that can act as a template for future node contributions.

• Required:
  • Title
  • uuid
  • Prerequisites (dependencies)
  • Learning objective(s)
  • Explanation Text / Lecture Note / Content
  • Assessment(s)
• Recommended:
  • Text, equations
  • Example code
  • References
  • External readings
  • Instructor guidance
  • Graphics
  • Videos
  • Audio files
  • Worked Examples
  • List ABET a-k objectives supported
  • Active Learning activities
  • Demonstration
  • Code completion exercises
  • Think pair share questions
  • citations/reference
  • Assessment(s)
  • Homework problems
  • Exam problems
  • Quiz questions
  • Other learning outcomes

Review Criteria document

There should be a review criteria document.

readme.md in Nodes

We should add a link to the ABET requirements.

Add LaTeX build checker

Add a checker that makes sure all latex builds.

Add a metadata checker to CI

As part of the PR checks, add a checker to CI that checks for required metadata in all nodes.

Add spell checker to CI

Continuous integration should do spell checking. Consider a glossary of nuclear terms. Don't require perfect spelling (probably impossible to get the full list of acceptable nuclear terms in the glossary). Just report bad spelling.

get nodes built into the website

build em.

Point to similar projects/inspiration from the readme

There is a references section of the main website to point to important resources. However, we should note, in the readme or similar documentation, the various tools and examples that gave us inspiration during this project. (prairielearn, relate, rosalind, etc.).

Move current website to org

This will be closed when a new repository at necx.github.io reflects what is currently at arfc.github.io/necx.

Create Mailmap

Create a mailmap file for the repo and related scripts in order to deduplicate authorship names

Make CI build the website

Make sure the CI builds a jekyll website??

New Node Script

This issue can be closed when the following capability exists:

A script can be run (e.g. new-node <uid>) which creates a new node directory structure ready for editing.

Create Useful Labels for issues in this org

Katy has a cool script for adding issue labels that are useful.

Set up Jekyll build

See also #3 . This can be closed when the nodes render online. This can be in conjunction with, or not in conjunction with, the necx.github.io site.

add pep8 checker to CI

All .py files should be pep8 compatible.

Prereqs

Can a node have no prereqs? I'm concerned that they might get too general; e.g., just putting "chemistry".

Establish user guidelines

Develop documentation for collaborators looking to identify and use curriculum resources. Specific documentation should include:

• Overview of the basic repository concept (i.e., what is there, how it is granulated, etc.)
• How to locate and acquire content, including identifying dependency content, associated media (images, assignments, evaluations, etc.)
• How to contribute new content or revise existing nodes