Search
⌃K

Version notebooks

Noteable provides a powerful versioning control engine that allows both manual and automatic saving of document edits and empowers users to restore, share, and export previous versions of a document.
Versioning is important because it preserves a historical record of a document for audit purposes and allows users to roll back accidental changes.
Noteable provides the ability to share particular versions of a document making it possible to continuously update a document while also collaborating with team members. Learn more: Share notebook versions​

Create versions

Noteable automatically saves a version of your document every 30 seconds or every 100 edits, whichever comes first.
There are 3 ways to manually save a notebook version:
Using File menu
Using Version menu
Using hotkeys
To create a new notebook version using the File panel:
  1. 1.
    Go to the notebook.
  2. 2.
    Open the File menu.
  3. 3.
    Click Create Named Version...
  4. 4.
    Provide a Version Name.
  5. 5.
    Add a description, if desired.
  6. 6.
    Click Create.
To create a new notebook version using the Version panel:
  1. 1.
    Go to the notebook.
  2. 2.
    Open the Version panel by clicking on the clock icon (
    ) in the right sidebar.
  3. 3.
    Click the plus sign (
    ) in the upper right.
  4. 4.
    Provide a Version Name.
  5. 5.
    Add a description, if desired.
  6. 6.
    Click Create.
To create a new notebook version using hotkeys:
  1. 1.
    Go to the notebook.
  2. 2.
    Press Cmd/Ctrl + S (Mac/Windows).
  3. 3.
    Provide a Version Name.
  4. 4.
    Add a description, if desired.
  5. 5.
    Click Create.
Create a version
The manually created version will now appear in the version panel which is accessible by clicking on the clock icon (
) in the right sidebar.

Manage versions

Automatically and manually created versions are available in the version panel which is accessible by clicking on the clock icon (
) in the right sidebar.
From the panel, you may:
  • Toggle the Version History button on an off to filter out the automatically created versions.
  • Navigate between the Live Version and historical snapshots.
  • Create a new version.
  • Manage versions by hovering over the version until the (
    ) menu appears.
  • Click on a version to view the snapshot content.
The options available to manage versions are:
  • Rename versions: allows you to rename manually created versions or add specific names to automatically created versions
  • Restore versions: allows you to restore a notebook to an earlier point-in-time snapshot.
  • Download versions: allows you to download a snapshot of the notebook in .ipynb format.
  • Duplicate versions: allows you to create a new notebook from a particular snapshot in the space and project of your choice.
  • Open in new tab: opens version in new tab for viewing and restoring.
  • Share link: allows you to share a particular version of the notebook with others using the same permissions as the parent notebook (learn more: Share notebook versions)
Comments are not preserved when versions are downloaded and duplicated.
Manage versions

Restore versions

Restoring versions allows you to revert a notebook to a historical snapshot to recover from error.
To restore a notebook to a previous snapshot:
  1. 1.
    Go to the notebook.
  2. 2.
    Open the Version panel by clicking on the clock icon (
    ) in the right sidebar.
  3. 3.
    Pick the Version you want to restore from.
  4. 4.
    Either:
    • Open the version and then click the Restore button the menu bar.
    • Hover over the version until the (
      ) menu appears and then select Restore from the menu options.
  5. 5.
    Confirm selection.
When a version is restored, a new entry will appear in the version history with the word (restored)appended to the version name so that the history is preserved.
Restore from snapshot
​
Previous
Schema Browser
Next - WORK WITH NOTEBOOKS
Using Git within Noteable
Last modified 1yr ago