Setting Up Your Workspace with Meteor Studio Documentation

Follow these steps to set up your workspace with the Meteor Studio Documentation. This guide assumes you have basic knowledge of using terminal or command prompt and Obsidian.

Prerequisites

Git installed on your computer [Appendix - A]
Obsidian installed on your computer. [Appendix - B]

Step 1: Choose a Directory

Select a directory on your computer where you want to save the documentation vault. This location should have enough space to accommodate future documentation updates.

Step 2: Clone the GitHub Repository

Open your terminal or command prompt. Navigate to the directory you chose in Step 1. Clone the Meteor Studio Documentation repository by running the following command:

git clone https://github.com/kpandya8/Meteor_Studio_Documentation.git

This command downloads the documentation into a folder named Meteor_Studio_Documentation within your selected directory.

Step 3: Open the Vault in Obsidian

Launch Obsidian. On the startup screen, select Open folder as vault. Navigate to the directory where you cloned the repository, select the Meteor_Studio_Documentation folder, and open it as your vault.

Step 4: Install Community Plugins

Within Obsidian, access the settings by clicking on the gear icon in the bottom left corner. Navigate to Community plugins and disable Safe mode to allow plugin installation. Search for the Git plugin and install it. This plugin enables you to sync your changes with the GitHub repository directly from Obsidian.

Step 5: Set Custom Settings

After installing the Git plugin, configure it according to your workflow. This may involve setting up automatic pull/push intervals, defining a custom commit message format, and other git-related preferences.

Go to Plugin Options in the settings menu.
Find the Git plugin settings.
Adjust the settings to fit your needs, such as:
- Setting up an automatic push interval to ensure your changes are regularly backed up.
- Configuring pull settings to automatically update your local documentation with any changes from the GitHub repository.

All Set!

You have successfully set up your workspace for working with Meteor Studio Documentation. This setup allows you to easily update documentation, collaborate with others, and ensure that all changes are synchronized with the GitHub repository.

Remember to regularly pull changes from the repository to stay updated and push your changes to contribute to the documentation. Happy documenting!

Appendix - A

Installing Git on Windows

Download Git for Windows
- Navigate to the Git website: https://git-scm.com/
- Click on the "Download" button for Windows. The site should automatically detect your operating system.
- Once the download is complete, locate the .exe file in your Downloads folder and double-click it to start the installation process.
Run the Installer
- Proceed through the installation steps. When you reach the "Select Components" screen, you can leave the default selections or customize them according to your preferences.
- Continue with the installation until you reach the "Adjusting your PATH environment" screen. Here, you have a few options, but for most users, the recommended option is "Git from the command line and also from 3rd-party software."
- Keep clicking "Next," choosing your preferred options until you reach the end of the setup wizard.
Verify Installation
- Open the Command Prompt by typing cmd in the Windows search bar and hitting Enter.
- Type git --version and press Enter. This command will display the currently installed version of Git, confirming the successful installation.
Configure Git (Optional)
- Set your global username: git config --global user.name "Your Name"
- Set your global email: git config --global user.email "your_email@example.com"

Installing Git on macOS

Install Homebrew (if not already installed)
- Open the Terminal app.
- Paste the following command and press Enter:
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
- Follow the on-screen instructions to complete the installation of Homebrew.
Install Git using Homebrew
- In the Terminal, type the following command and press Enter: brew install git
- Homebrew will download and install Git and all its dependencies.
Verify Installation
- Still in the Terminal, type git --version and press Enter. This command will show the version of Git that was installed, indicating that the installation was successful.
Configure Git (Optional)
- Set your global username: git config --global user.name "Your Name"
- Set your global email: git config --global user.email "your_email@example.com"

Appendix - B

Installing Obsidian on Windows

Download the Installer
- Visit the Obsidian official website: https://obsidian.md/
- Click on the "Download" button.
- Choose the Windows version and click on it to start the download process.
Run the Installer
- Once the download is complete, locate the downloaded .exe file in your Downloads folder.
- Double-click on the file to start the installation process.
- Follow the on-screen instructions. You can choose the installation location or leave it at the default location.
Launch Obsidian
- After installation, Obsidian can be launched either through the Start Menu or by double-clicking the desktop shortcut if you chose to create one during the installation process.
First Launch
- Upon the first launch, you might be prompted to create a new vault or open an existing one. A vault in Obsidian is a folder on your computer where your notes will be stored.

Installing Obsidian on macOS

Download the Installer
- Visit the Obsidian official website: https://obsidian.md/
- Click on the "Download" button.
- Choose the macOS version and click on it to start the download process.
Install Obsidian
- Once the download is finished, open your Downloads folder and find the .dmg file.
- Double-click on the .dmg file to open the installer.
- Drag the Obsidian icon to the Applications folder within the installer window.
Launch Obsidian
- Open your Applications folder and double-click on Obsidian to start the application.
- If you see a warning stating that Obsidian is an application downloaded from the internet, click "Open" to proceed.
First Launch
- As with Windows, you'll be prompted to create a new vault or open an existing one. Choose according to your preference to start using Obsidian.

README