|
| 1 | +# d-sys.wiki |
| 2 | + |
| 3 | +[](https://github.com/captradeoff/d-sys-wiki/blob/master/LICENSE) |
| 4 | + |
| 5 | +**d-sys.wiki** is your comprehensive resource for all things related to distributed systems. This repository contains the source code for the [d-sys.wiki](https://d-sys.wiki) website, which provides accessible explanations, resources, and tools for understanding, architecting, and building distributed systems. |
| 6 | + |
| 7 | +## π Content |
| 8 | + |
| 9 | +The wiki includes: |
| 10 | + |
| 11 | +- Simple, casual explanations of distributed systems concepts |
| 12 | +- Early access to pre-prints on distributed systems research |
| 13 | +- Case studies with reproducible research and code examples |
| 14 | +- Information about open source projects, software, and tools |
| 15 | +- Curated links to top books and talks in the field |
| 16 | +- And more! |
| 17 | + |
| 18 | +## π Getting Started |
| 19 | + |
| 20 | +### For Readers |
| 21 | + |
| 22 | +Visit [d-sys.wiki](https://d-sys.wiki) to access the published content. |
| 23 | + |
| 24 | +### For Contributors and Local Development |
| 25 | + |
| 26 | +This wiki is built using [MkDocs](https://www.mkdocs.org/) with the terminal theme. |
| 27 | + |
| 28 | +#### Prerequisites |
| 29 | + |
| 30 | +- Python 3.x |
| 31 | +- pip (Python package manager) |
| 32 | + |
| 33 | +#### Local Setup |
| 34 | + |
| 35 | +1. Clone the repository: |
| 36 | + ```bash |
| 37 | + git clone https://github.com/captradeoff/d-sys-wiki.git |
| 38 | + cd d-sys-wiki |
| 39 | + ``` |
| 40 | + |
| 41 | +2. Install MkDocs and required plugins: |
| 42 | + ```bash |
| 43 | + pip install mkdocs |
| 44 | + pip install mkdocs-terminal |
| 45 | + pip install mkdocs-git-revision-date-plugin |
| 46 | + pip install mkdocs-spellcheck-plugin |
| 47 | + ``` |
| 48 | + |
| 49 | +3. Run the development server: |
| 50 | + ```bash |
| 51 | + mkdocs serve |
| 52 | + ``` |
| 53 | + |
| 54 | +4. Open your browser and navigate to `http://localhost:8000` to see the local version of the wiki. |
| 55 | + |
| 56 | +## π Contributing |
| 57 | + |
| 58 | +Contributions to d-sys.wiki are welcome and appreciated! Here's how you can contribute: |
| 59 | + |
| 60 | +1. **Report Issues**: If you find errors or have suggestions, please [open an issue](https://github.com/captradeoff/d-sys-wiki/issues). |
| 61 | + |
| 62 | +2. **Submit Content**: To add or modify content: |
| 63 | + - Fork the repository |
| 64 | + - Create a new branch for your changes |
| 65 | + - Make your changes to the relevant Markdown files in the `docs/` directory |
| 66 | + - Submit a pull request |
| 67 | + |
| 68 | +3. **Content Guidelines**: |
| 69 | + - Write in a clear, accessible style |
| 70 | + - Include examples where appropriate |
| 71 | + - Cite sources for technical information |
| 72 | + - Follow the existing formatting conventions |
| 73 | + |
| 74 | +## ποΈ Project Structure |
| 75 | + |
| 76 | +``` |
| 77 | +d-sys-wiki/ |
| 78 | +βββ docs/ # Documentation source files |
| 79 | +β βββ index.md # Home page |
| 80 | +β βββ about/ # About section |
| 81 | +β βββ fundamentals/ # Fundamental concepts |
| 82 | +β βββ img/ # Images and resources |
| 83 | +βββ mkdocs.yml # MkDocs configuration |
| 84 | +βββ CNAME # Custom domain configuration |
| 85 | +βββ LICENSE # MIT License |
| 86 | +``` |
| 87 | + |
| 88 | +## π License |
| 89 | + |
| 90 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 91 | + |
| 92 | +## π¬ Contact |
| 93 | + |
| 94 | +- GitHub: [@captradeoff](https://github.com/captradeoff) |
| 95 | +- Twitter/X: [@captradeoff](https://x.com/captradeoff) |
0 commit comments