Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add /skills folder to the repo and load that markdown for each skill #286

Open
jaredatron opened this issue Sep 20, 2017 · 6 comments
Open

Comments

@jaredatron
Copy link
Contributor

jaredatron commented Sep 20, 2017

right now when you go to a skills page like https://curriculum.learnersguild.org/skills/Can-add-features-to-a-pre-existing-Node-codebase, you only see the skill name a link to modules that reference that skills.

User Stories

  • as a curriculum editor I should be able to edit /skills/Can-add-features-to-a-pre-existing-Node-codebase.md and have that markdown displayed on the skills page
  • as a user i can see "improve this page", "view on github" on the skills pages to edit the skills markdown file

Technical Nodes

  • add skills markdown to the digest
  • render the markdown on the skills page
  • generate markdown files for each skill
  • ensure the file name matches the skill slug
  • ensure the "rename-skill" script moved the skill markdown file to the new skill name

Example Skill

{
  "id": "Can-use-git-fetch",
  "name": "Can use `git fetch`",
  "rawText": "Can use `git fetch`",
  "modules": [
    "Saving-Progress-With-Git-And-GitHub"
  ],
  "path": "/skills/Can-use-git-fetch",
  "contexts": [
    "Git"
  ],
  "directoryName": "Can-use-git-fetch",
  "markdownFilePath": "/skills/Can-use-git-fetch.md"
}

url: https://curriculum.learnersguild.org/skills/Can-use-git-fetch
repository file path: /skills/Can-use-git-fetch.md

/skills/Can-use-git-fetch.md

# Can use `git fetch`

Git fetch is awesome…

whatever

## Resources

- http://google.com duh!
@jaredatron
Copy link
Contributor Author

your generation helper script should generate a blank skill markdown file like this

# ${skill.name}

- _description tbd_

## Resources

### Reading

- _nothing here yet, please add something_

### Watching

- _nothing here yet, please add something_

@hhhhhaaaa
Copy link
Contributor

hhhhhaaaa commented Sep 22, 2017

Plan of Action
1.) Create markdown files for each individual skill, as described. Make sure name matches skill id, and title matches name.
a.) Digest generates markdown file from it's own information. Id comes from the skill's id. Name comes from the skill's name.

2.) Add markdownFilePath to individual skill object.
a.) Edit digest/skills.js to include a markdownFilePath key with a value of 'skills/${id}.MD'

3.) Render the markdown file on individual skill page.
a.) Manipulate helper files to accept markdownFilePath.
b.) Put markdownFilePath into render.
c.) Fix styling.

4.) The rename-skill script should rename the skill markdown file.
a.) Figure out rename-skill script.
b.) Edit rename-skills script to function as described.

https://github.com/hhhhhaaaa/curriculum/tree/286

@lumodon
Copy link

lumodon commented Sep 25, 2017

PR: #302

@lumodon
Copy link

lumodon commented Sep 27, 2017

PR: #336

@EmmaEm
Copy link

EmmaEm commented Sep 28, 2017

PR: #349

@lumodon
Copy link

lumodon commented Oct 2, 2017

PR: #363 (Squashed version)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants