Scenario

As an admin or content owner, you have a technical tutorial you want to import to PlusPlus as a codelab. This can be a new codelab you’re wanting to import to PlusPlus or an updated version of an existing one.

Solution

Import the tutorial using the steps below:

  1. Zip your Google Codelab-formatted tutorial, along with any assets, such as images.
    Learn more about authoring Google Codelabs.
    Learn more about zipping your codelab files in the Go deeper section below.

  2. In your PlusPlus Catalog, click New and select Codelab from the menu.
    Note that you may need to enable codelabs first at Settings > Site > Supported content types.


    If you want to import a new version of an existing codelab, access the codelab in PlusPlus, open the context menu (button with three dots), and select Import new version.


    The New Codelab (or Update Codelab) dialog opens.

  3. Click upload a codelab file.
    Your file explorer opens.

  4. Select the zipped codelab file from your file explorer.

  5. Click Import.
    A dialog opens showing import progress until completion, and you are navigated to the Edit Codelab page for the new codelab. (Or, if updating a codelab with a new version, you are navigated back to the codelab’s landing page, and the process is complete).

  6. Update the codelab as needed.
    Note that the system automatically attempts to set the codelab's name, description, duration, and tags, based on metadata included in the codelab file.

    The person who imports the file is added as the codelab Maintainer by default.

  7. Click Save.
    The new codelab is added to the Catalog and is discoverable for engineers.

You can now assign your new codelab to or integrate it into a track.

Go deeper

Zipping your codelab files

We currently only support importing a single zipped Google Codelab-formatted Markdown file into PlusPlus. The zip file you create should contain the codelab Markdown (.md) file, plus any assets, but avoid other files or folder structures. The import tool picks up the first .md file in the zip file that is not README.md.

The formatting for authoring in Google Codelabs is familiar to engineers, and PlusPlus can use the metadata defined in a Markdown file to build out codelab details upon import. In the future, we’ll also support importing codelabs authored in Google Docs.

Are users already in a codelab able to see the updated version?

Once learners launch a codelab, they remain on the same version of the codelab until completion, even if you add a new version of the codelab while they are still engaging it. To engage the new version, learners already in the codelab must drop their assignment to the codelab and launch again. However, we are soon to release a feature that allows learners to choose whether to Relaunch the codelab with the latest version or to Continue their progress with the previous version.

See also

Did this answer your question?