Adapt Learning Community: Use of adapt-buildkit-rub

Hello,

I'm trying the adapt-buildkit-rub buildkit. I'm trying the different course structures, it works fine with the single struture ( src/course), and Kineo's (src/courses) ... meaning, I know where to put the src files so the build works.

But the structure I'm most interested is "build/courses" (as they call it in the documentation), but it's not working for me, I'm sure I'm just not placing the files in the right places.

Could somebody please tell me what the correct directory structure is? (I want to have only 1 copy of the src assets).

Thank you.

rub-example-setup.zip

No problem at all, having looked at the README I can see it is a bit misleading

One thing to remember is that most of the work we do here consists of creating multiple courses from a single src, therefore RUB is set up specifically to support that.

Therefore you actually need to have a 'builds' folder with one or more subfolders in it

I've taken the standard download of the framework and changed it over to this structure - see attached (you'll need to extract and then run $ adapt-buildkit install rub)

I'll see about making the README a bit clearer

Show parent | Reply

Thanks a lot Matt, it's working fine now!

So... from that structure, and from what you describe, all the courses (in that "set" of courses that are built from a single src) will have the same components, extensions, etc., right?

Show parent | Reply

not necessarily - you can exclude plugins from a course (or courses) by using a file called 'rubconfig.json' (currently called rubconfig.json.tmp to stop it from being used)

For example if my project consisted of two courses, one of which uses boxMenu and spoor whilst the other one has no menu and doesn't use spoor, then I would set up rubconfig.json like this:

{
"excludes": {
    "p101": {
      "folderNames": [
        "adapt-contrib-spoor",
        "adapt-contrib-boxMenu"
      ]
    },
    "folderNames": []
},
"clearLogs": true
}

Where 'p101' is the course that shouldn't have spoor or boxMenu

I have heard reports that this can mean you need to use $ rub -f to actually do the exclusions (or not) correctly - be interested to know if you find this as well.

Show parent | Reply

I tested this, and I did not need to use -f. In other words, the exclusions in my rubconfig.json worked right when I ran just " ./rub"

Show parent | Reply

brilliant, thanks for the feedback

Show parent | Reply

I've edited the README to be a bit clearer and contain info about how to exclude plugins from courses. If you get a chance, could you have a read of this section and this section to let me know if they're more helpful now?

Show parent | Reply

Yes, those sections are more helpful now. Very clear explanations. Thanks!

Show parent | Reply