Skip to content

Setup for Contributors

Configuration for Contributors

To contribute to the Knowledge Base, follow these steps to set up your development environment:

  1. Create a GitHub Account
  2. If you don't already have a GitHub account, sign up at GitHub.
  3. Request access to the private KB repository from the repository administrator.
  4. You are looking to access:
missingmoniker/ovi-gc-knowledge-base.git
  1. Clone the Repository
  2. Once access has been granted, clone the repository to your local machine to create a copy of all the production files.
  3. Note the folder you designate as your local replica; this will be used as the vault folder when setting up Obsidian.
git clone https://github.com/missingmoniker/ovi-gc-knowledge-base.git
  1. Verify the Files
  2. Using File Explorer, verify that you have successfully downloaded a copy of the production files.

  3. Ensure that all necessary files and directories are present.

  4. Set Up Obsidian

  5. Open Obsidian.
  6. Create a new Vault by selecting "Open folder as vault."

  7. Choose the location of your cloned GitHub repository as the vault folder.

  8. Contribute Content

  9. In Obsidian, open an existing .md file to start contributing content.
  10. Make your changes, ensuring they align with the KB's formatting and content guidelines.

  11. Save your changes locally.

  12. Commit and Push Changes

  13. Use GitHub CLI or GitHub Desktop to commit your changes to the repository.
  14. Push your changes to the remote repository and create a pull request for review.

By following these steps, you will be able to contribute effectively to the Knowledge Base, ensuring that all content is accurately maintained and up to date.