The UKRN Workshop Builder is an interface for GitHub that enables users to clone and customise GitHub Pages websites based on The Carpentries' workshop template. Users require a GitHub account. Once they have logged in an authorised the app to make changes on their behalf, they can create a new workshop website using the tool (creating a new GitHub repository), find content created by other users of the tool, and customise content.
Data
| Name | Type | Default value | Description |
|---|---|---|---|
activeStep |
Number | 0 |
Progression stage through the workshop creation and customisation process. Used to navigate between the Buefy step children. |
preambleRead |
Boolean | false |
Whether the user has read the initial preamble and attempted to log into GitHub. |
workshopTemplate |
null | null |
Currently unused. |
Computed
| Name | Type | Description |
|---|---|---|
configReady |
Boolean | Whether the configuration file (_config.yml) of the user's main repository is complete and well formatted. |
latestStep |
Number | The most advanced step the user should be able to access in the create-and-customise process. |
lastError |
Array.<Error> | The most recent error from any of the store components. |
Methods
-
stepType(myStepNum) → {string}
-
Calculate the appropriate Buefy style string for a step.
Parameters:
Name Type Description myStepNumNumber Number of the step. Returns:
string - 'is-success' if the step is complete, otherwise ''