Knowledge centre templates

Knowledge centre templates allow you to quickly and easily set up complex demos or boilerplate in your Faculty projects.

Templates can configure a variety of platform resources, including:

  • Notebooks and other files in the workspace

  • Environments

  • Jobs

  • Apps

  • APIs

When applying a template, the resources it defines are added to an existing project.

Note

In an upcoming release, users will also be able to create new projects from Knowledge centre templates directly.

Templates can also define parameters, which provide for customisability by the user when being applied to a project.

Using Knowledge centre templates

To use a template in the Knowledge centre, you need to apply it to a project. On application, a number of resources will be created in the project. After selecting a template in the Knowledge centre, you can browse the resources it will create and and parameters that are available.

For example, we can see that the Plotly Dash demo will create some files in the workspace and one Faculty app, which runs the demo:

Navigating the the “Parameters” section, we can see that this template allows us to customise the name and subdomain of the app that will be created:

Now that we’re satisfied that this template provides us with what we need, we can go about applying it to a project. To do this, click “Use this template” at the top right of the screen and select “Add to existing project”.

This will open the following form, where we can customise how the template will be applied:

Choose the project you wish to apply the project to, and select where in that project’s workspace any files are to be placed. By default, files will be placed in the root of the workspace. If a directory is entered that does not yet exist, it will be created on application of the template. Below, you are also able to enter values for the template’s parameters.

Once you’ve configured the template as you’d like it, click the “Validate” button to check that all the configured resources are valid and that there are no conflicts with existing resources. Conflicts that can occur are:

  • Conflict with files that already exist in the workspace

  • Environment, job, app or API names, which must be unique within a project

  • App or API subdomains, which must be unique across a whole Faculty deployment

If you get any validation errors, adjust the workspace path or parameters as appropriate and try again.

When you have a valid configuration, click “Add to project” to apply it. Once applied, the project will be opened and you can start using the created resources. In the above example, I can navigate to the “Apps” section of “Deployments” and start the app that has been created. It starts a minimal working example of a Plotly Dash app, as expected: