Your first tutorial

1. Write the file

Create .ondaclip/tutorials/invite-a-colleague.yaml. The file name is the tutorial id.

id: invite-a-colleague
account: admin
title: { en-US: Invite a colleague, fr-CA: Inviter un collègue }
steps:
  - id: open-team
    title: { en-US: Open your team, fr-CA: Ouvrir votre équipe }
    start: /team
    shots:
      - say:
          en-US: Everyone in your workspace is on the Team page.
          fr-CA: Toutes les personnes de votre espace sont sur la page Équipe.
        show: { id: team-grid }
      - say:
          en-US: To bring a colleague in, click Invite.
          fr-CA: Pour faire entrer un collègue, cliquez sur Inviter.
        click: { id: team-invite-button }

Every text viewers read or hear must exist in every language of the product. See the tutorial file for the full format and actions and targets for the actions.

2. Add it to the publication list

.ondaclip/publication.yaml

chapters:
  - number: 1
    title: { en-US: Your team, fr-CA: Votre équipe }
    tutorials:
      - id: invite-a-colleague
        icon: users
        description:
          en-US: Invite a colleague and choose their role.
          fr-CA: Invitez un collègue et choisissez son rôle.

3. Open a pull request

A tutorial is code, so open a pull request with both files. Your team reviews the wording like any other change.

4. Film and review

In the studio, start filming the tutorial. When it’s done, watch the clip in each language. If a step fails, you see its screen and the reason, and Ondaclip can suggest a fix.

5. Publish

When the clips look right, publish them. The videos, posters and manifest go to the folder you chose during setup, and your app shows them.