IDEALIT Passport
Menu

Passport search

Find a mission or fix

Type at least two characters.

    Browse help by symptomBrowse all references
    How to start
    Curriculum previewThis is not your assigned passport. No identity, answers, or completion progress are stored here.How to start your passport
    Handbook / reference

    reference

    Obsidian (Optional Handbook View)

    Goal: optionally read and annotate the onboarding repository as a local Obsidian vault after GitHub and Git are already working.

    View exact sourceReturn to my dashboard

    Goal: optionally read and annotate the onboarding repository as a local Obsidian vault after GitHub and Git are already working.

    Prerequisites: complete at least Checkpoint 8 of the Onboarding Workbook. GitHub browser access, Git, VS Code OAuth, cloning, branches, and pull requests must already work.

    Obsidian is not required for the passport. Do not delay onboarding because you prefer another notes application.

    Install And Clone#

    Execution context: your local computer.

    1. Install Obsidian from https://obsidian.md/.
    2. In VS Code, open the Command Palette and run Git: Clone.
    3. Enter https://github.com/IDEALLab/onboarding-IT.git.
    4. Choose a normal local folder outside OneDrive, iCloud, and existing vaults.
    5. Open the cloned folder in VS Code and run:
    git status --short --branch

    Expected result: git status reports the repository's current branch. The vault root is the cloned onboarding-IT folder containing README.md, not its parent directory and not onboarding_IT_guides/.

    Open The Vault#

    1. Select Open folder as vault.
    2. Choose the cloned onboarding-IT root folder.
    3. Open README.md only to verify rendering. Resume your saved workbook checkpoint in the browser; Obsidian does not become a second onboarding route.

    Keep Personal Settings Out Of Git#

    The repository ignores local .obsidian/ state. Verify before committing:

    git status --short

    Do not force-add .obsidian/, workspace layouts, caches, or personal notes. Store project-confidential notes only in supervisor-approved systems.

    Updating Your Local Copy#

    If you have no local handbook edits:

    git status --short
git pull --ff-only

    Expected result: either Already up to date. or a fast-forward update. If git status shows local changes, stop and review them before pulling.

    Common Failures And Safe Recovery#

    • Vault appears empty/wrong: reopen the repository root containing README.md.
    • Private clone fails: accept the GitHub invitation and configure GitHub authentication; do not put a token in the URL.
    • Obsidian files appear in Git: confirm .obsidian/ is ignored and unstage those files without deleting personal settings.
    • Pull refuses because of local changes: inspect the diff; do not run a hard reset merely to update the handbook.

    Verification#

    • README.md and the workbook render in Obsidian.
    • git status --short does not list .obsidian/.
    • The same handbook remains readable on GitHub without Obsidian.

    Ask For Help When#

    Git reports conflicts or the private repository remains inaccessible after the organization invitation was accepted.