Skip to content

Latest commit

 

History

History
 
 

README.md

All of these scripts require you to have Node available in your environment. Get it from NodeJS.org.

substitute_article_urls.js

A node script to replace all Learning Path article links with urls for a particular platform, using urls.yaml.

Usage:

npm ci
node substitute_article_urls.js $TARGET

For example, to point all links to innersourcecommons.org:

node substitute_article_urls.js isc

generate_learning_path_markdown.js

A node script to generate markdown files required for hosting Learning Path on innersourcecommons.org.

This script requires a GitHub access token, as it uses the GitHub API to get Learning Path contributors. Your token does not require any scopes, as the Learning Path is Open Source. To provide this, create a .env file in this directory in the following format:

TOKEN=<your_github_token>

Usage:

npm ci
node generate_learning_path_markdown.js

How to update innersourcecommons.org with new articles

Anytime there are new articles written, you need to run the script that generates the new pages on the innersourcecommons.org site.

  1. Clone the InnerSourceCommons/InnerSourceLearningPath and InnerSourceCommons/innersourcecommons.org repos.
  2. Is this the first time that articles have been written for this section in this language? If so, then do both of the following:
  1. Run generate_learning_path_markdown.js as described above.
  2. cp -r learningpath/* <path-to-innersourcecommons.org-repo>/resources/learningpath/.
  3. Open a pull request with the modified files in the InnerSourceCommons/innersourcecommons.org repo.

Note that these steps only needs to happen when there are new articles written. Changes to existing articles will automatically show up on the innersourcecommons.org site.