Quick reminder of the process

Login to WorkflowHub
Select Contribute on the main page
Select the Import Git repository option
Add your Git repository URL and click Register
Complete the required metadata (title, projects/teams and creators)
Click Register
Review the final workflow entry and edit as needed

Important: You can also register your workflow using a Research Object Crate (RO-Crate). This is an option for advanced users, and further instructions can be found here. The advanced way: registering a workflow RO-crate When you have created a workflow RO-Crate of your workflow using the python package, and want to upload or reference it.

In development Registering a workflow RO-Crate using the API We are working on a WorkflowHub API that will allow the user to automatically register workflow RO-Crates. Not all features are yet developed, but a glimpse of the API can be found here.

Onboarding to WorkflowHub

WorkflowHub will help make your workflows findable and citable, and this guide will help you get started with that process.

Tip: if you want to test WorkflowHub and its features, there is a development instance available here.

1. Register yourself on WorkflowHub

Register yourself on the sign up page of WorkflowHub if you do not have an account. You can also log in using your LS Login or GitHub credentials.

2. Decide which `Space` you would like to create a `Team` in

Figure 1 below highlights the basic structure of WorkflowHub, and examples of the three types of Spaces where you could create a Team. Learn more about Teams and Spaces here.

You can request to create a Team in any or all of the following Spaces:

Independent teams: this is where you can create a team if you do not require a specific space
A pre-existing space, for example:
A new space: if a pre-existing space is not suitable, you can create a space
- This is a good option if you represent a group, consortium, or community where multiple teams might want to register with WorkflowHub

Spaces and teams explained — Fig 1. Left - the relationship between the structural elements of WorkflowHub: Spaces, Teams and workflows. Right - examples of where you can create your new team on WorkflowHub.

Note: you can create multiple teams in multiple spaces, depending on your requirements.

3. Create a team or join an existing team

Go to the create and join a team page from WorkflowHub to do so.

More information on how to join a team can be found on the how to create and join teams and spaces

Important: if you are creating a team, make sure the team name is descriptive.

Figure 2 shows the minimum information required for a new team, which includes:

Space - the space you selected or created in step 2 above
Team name
Team organization - the organization that should be linked to your team on WorkflowHub. e.g. University of Melbourne
- If your organization is not yet on WorkflowHub, you can create an organization

Important: you can add multiple organizations to both your profile and teams on WorkflowHub.

Fig 2. Screenshot of required minimum information (numbered) that needs to be entered into the *Create a New Team* wizard on WorkflowHub.

4. Register workflow(s)

Workflows can be registered using the WorkflowHub wizard

There is an extensive guide to the workflow registration process available in the WorkflowHub documentation.

Important: We recommend importing a git repository (e.g. GitHub), since WorkflowHub is a hub / registry and not a repository.

Quick reminder of the process