Link Search Menu Expand Document

Quickstart

This guide will cover setting up the layout describe above.

  1. Run Initialize Workspace to create a new company workspace
  2. Run Vault Add and a new local vault named {company} (replace with your company name)
    • NOTE: if you already have existing individual vaults, you can transfer files by using the mv command and then running > Reload Window to sync up the metadata
  3. Run Vault Add again for all users in your company user-{username}
  4. Run Vault Remove to remove the default vault that got created when you created the workspace
  5. For every vault you created, create a git repository and convert it to a remote vault by following the instructions here. When your done, the vaults section of your dendron.yml should look something like the below.
    vaults:
        -
            fsPath: dendron
            remote:
                type: git
                url: 'git@github.com:dendronhq/dendron.git'
        -
            fsPath: user-kevin
            remote:
                type: git
                url: 'git@github.com:dendronhq/user-fred.git'
        -
            fsPath: user-kpats
            remote:
                type: git
                url: 'git@github.com:dendronhq/user-fred.git'
    
  6. Create a repo for your workspace and push this as well (eg. workspace-{company})
  7. For each user in your team, have them clone the workspace repo. They can run Change Workspace with the path to the workspace to initialize it. Dendron will initiate all remote vaults during the process.
  8. (Optional): Add the schema vault as a remote vault to get access to some useful schemas