Skip to content

The TUM Blockchain Club Knowledge Vault is a collective effort to built a free educational database for computer science knowledge in the distributed systems space.

Notifications You must be signed in to change notification settings

TUM-Blockchain-Club/TBC-Knowledge-Vault

Repository files navigation

The Knowledge Vault

Introduction

Welcome to the TUM Blockchain Club Knowleddge Vault - the space where we collectively gather all our knowledge in the space of Distributed System, Blockchain, Distributed Ledger Technologies and many more topics.

This project is a collaborativ effort to gather useful information and educational material. We do not gurantee the correctness of any knowledge in this vault, however the knowledge base ist strictly maintained and we strive for delivering high quality and correct content.

The Technical University Munich is not affiliated with any of the content found in this vault. All content in this vault is of our own creation and a collection of the things we've learned and researched.

If you find that parts of this vault are incomplete or incorrect, then please check out the Contributing section of this document, to open an issue. We're always happy about new contributions.

How to use

Cloning the Vault

To use the knowledge vault, simply clone it into your preffered directory using git:

git clone https://github.com/TUM-Blockchain-Club/TBC-Knowledge-Vault.git <Directory>

Obsidian.md

Obsidian.md is a knowledge base tool that manages knowledge as a vault (Directories) of Markkdown files. It is a community driven platform which is highly customisable to your needs. There are many community plugins, different themes and configurations to make you comfortable managing all your knowledge.

We've decided to go with obsidian for our knowledeg base, because it gives us the freedom of managing our data independently of the software itself.

To browse the TBC Knowledge Vault, dowload obsidian and simply open the directory you've cloned in [Cloning the Vault](#Cloning the Vault).

If you're new to obsidian, you can use our Obsidian Configuration as a guide to get started with some use full plugins.

Website

We're planning to host the TBC Knowldege Vault as a webiste at some point in the future. Stay tuned for more!

Vault Structure

This is still work in progress, please check out later!

Contributing

Hi there, thanks for sharing your knowledge with the community! To contribute to the vault please first check out our code of conduct and our contribution styleguide.

Branches

To manage contributions to the vault, we organise everything in topic branches. These branches refer to a specific set of labels, which correspond to a specific area of expertise. The labels are used inside the vault to easily search and find the thing you're looking for.

If you want to contribute to the knowledge vault, check out the different topic branches or create a new branch if you can't find your topic. Commit all your changes to that branch and create a PR when you're done!

Pull Requests

To add your knowledge to the vault please create a pull requests to the review branch. We're then checking out your contribution and are going to merge it into the stable vault on the main branch.

About

The TUM Blockchain Club Knowledge Vault is a collective effort to built a free educational database for computer science knowledge in the distributed systems space.

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published