pyvec / pyvec/naucse.python.cz

Materials of archived courses should be freezed/should not change

Open
#214 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
No language data
Stars
335
Forks
119
Avg merge
3h 6m
Merged PRs (30d)
1

Description

Right now courses, for example runs/2017/pyladies-praha-jaro/info.yml, just reference lessons by their path, for example beginners/testing.

What happens when the lesson moves to other directory or even disappears? It would break content of some previous course if someone doesn't dedicate their time to update all such references.

What happens when the lesson changes? I think the content of the old course should be preserved as is, as it was presented and teached.

Since all materials are currently in git on Github, accessible through git and Github APIs, this could be doable for example by creating a new branch after each course ends and material for the archived course could be rendered from the given branch instead of master.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with runs/2017/pyladies-praha-jaro/info.yml and trace how its lesson paths are rendered. Then investigate the Git and GitHub API-based approach mentioned in the issue; done means archived course materials remain available and unchanged when current lessons move, disappear, or are edited.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, yaml
Domain
content, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.