Tutorial: submitting your first DevNote

Overview¶

This tutorial will walk you through the entire workflow for submitting a DevNote. This tutorial is broken into three sections.

• Creating a DevNote project from the standard template

• Populating the DevNote with content

• Reviewing and submitting the DevNote for display

This tutorial assumes the following:

• It assumes that you have access to Nucleus Hub and are familiar with its basic features.

• Have a Curvenote account.

• Have an ORCiD.

If you do not have these things please see the Tutorial: getting started with Nucleus Hub.

Creating project from template¶

• From the Launcher window select the button “Create” in the “Developer Notes” toolbar and follow the dialogue:

  • Enter a directory name for the DevNote: template

  • Project title: My first project

  • Subtitle: My first subtitle

  • Description: My first Description

  • Add author(s): [YOUR ORCiD]

  • Keywords: Hit [Enter] to skip

  • Would you like to start a local server now? n

  • Exit the terminal and return to the Launcher Window

• Preview your DevNote.

  • In your file directory, navigate to the directory /devnotes/template it should appear like this.

  • While you’re in the devnotes/template directory, click the button “Preview” in the “Developer Notes” toolbar of the Launcher window.

  • You will likely see an error message. That’s ok.

  • Open the file main.md in your directory

  • Create a split screen by dragging the “Preview” tab to the right corner of the screen.

  • Make an edit, say to the level 1 heading, e.g. #Background - edited. The preview window should automatically refresh and you should now be able to preview any updates to your DevNote in realtime.

Error message

Splitscreen

Authoring the DevNote¶

Review and submission¶

• Preview your DevNote

• Submit your DevNote