rubyforgood / rubyforgood/skillrx

Refactor Import Script and Files

Open
#402 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Scripts
Dominant language
Ruby
Stars
16
Forks
11
PR merge metrics
No merged PRs in 30d

Description

The import script was written to support the registration of actual content from CMES-Pi into SkillRX. That task is complete and we no longer need that functionality. The script and the supporting files are still useful for setting up development environments and resetting the staging environment. We want to modify them to specifically support development/staging and to not run in production.

Also, because the training documents are proprietary, we do not want real content in staging.

We want the script to allow us to create a full content set that is parallel in size/load to production, but which does not contain real content.

  • Block the script from running in production.
  • Run entirely off the local files OR from randomly-generated content
  • Upload training documents for the generated topics using the sample files in spec/fixtures/files
  • Add an MP3 file to the sample files

Contributor guide

Open the contributing guide

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

Inspect the import script and its supporting files, then review the sample files in spec/fixtures/files. Start by tracing how the script selects its environment and content sources. Done means production execution is blocked, development and staging can receive a full-scale non-proprietary content set, training documents use the sample files, and an MP3 is included.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
content, devops, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.