|
1 | 1 | # d-sys.wiki |
2 | 2 |
|
3 | | -[](https://github.com/captradeoff/d-sys-wiki/blob/master/LICENSE) |
| 3 | +[](https://github.com/captradeoff/d-sys-wiki/blob/master/LICENSE) |
4 | 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. |
| 5 | +**d-sys.wiki** is a resource for distributed systems. this repo contains the source for [d-sys.wiki](https://d-sys.wiki) website, providing explanations, resources, and tools for understanding and building distributed systems. |
6 | 6 |
|
7 | | -## 📚 Content |
| 7 | +## 📚 content |
8 | 8 |
|
9 | | -The wiki includes: |
| 9 | +- simple explanations of distributed systems concepts |
| 10 | +- pre-prints on distributed systems research |
| 11 | +- case studies with code examples |
| 12 | +- open source projects and tools |
| 13 | +- links to books and talks |
10 | 14 |
|
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! |
| 15 | +## 🚀 getting started |
17 | 16 |
|
18 | | -## 🚀 Getting Started |
| 17 | +### for readers |
19 | 18 |
|
20 | | -### For Readers |
| 19 | +visit [d-sys.wiki](https://d-sys.wiki) to access the content. |
21 | 20 |
|
22 | | -Visit [d-sys.wiki](https://d-sys.wiki) to access the published content. |
| 21 | +### for contributors |
23 | 22 |
|
24 | | -### For Contributors and Local Development |
| 23 | +built with [mkdocs](https://www.mkdocs.org/) using terminal theme. |
25 | 24 |
|
26 | | -This wiki is built using [MkDocs](https://www.mkdocs.org/) with the terminal theme. |
| 25 | +#### prerequisites |
27 | 26 |
|
28 | | -#### Prerequisites |
| 27 | +- python 3.x |
| 28 | +- pip |
29 | 29 |
|
30 | | -- Python 3.x |
31 | | -- pip (Python package manager) |
| 30 | +#### local setup |
32 | 31 |
|
33 | | -#### Local Setup |
34 | | - |
35 | | -1. Clone the repository: |
| 32 | +1. clone the repo: |
36 | 33 | ```bash |
37 | 34 | git clone https://github.com/captradeoff/d-sys-wiki.git |
38 | 35 | cd d-sys-wiki |
39 | 36 | ``` |
40 | 37 |
|
41 | | -2. Install MkDocs and required plugins: |
| 38 | +2. install mkdocs and plugins: |
42 | 39 | ```bash |
43 | 40 | pip install mkdocs |
44 | 41 | pip install mkdocs-terminal |
45 | 42 | pip install mkdocs-git-revision-date-plugin |
46 | 43 | pip install mkdocs-spellcheck-plugin |
47 | 44 | ``` |
48 | 45 |
|
49 | | -3. Run the development server: |
| 46 | +3. run dev server: |
50 | 47 | ```bash |
51 | 48 | mkdocs serve |
52 | 49 | ``` |
53 | 50 |
|
54 | | -4. Open your browser and navigate to `http://localhost:8000` to see the local version of the wiki. |
55 | | - |
56 | | -## 📝 Contributing |
| 51 | +4. open browser to `http://localhost:8000` |
57 | 52 |
|
58 | | -Contributions to d-sys.wiki are welcome and appreciated! Here's how you can contribute: |
| 53 | +## 📝 contributing |
59 | 54 |
|
60 | | -1. **Report Issues**: If you find errors or have suggestions, please [open an issue](https://github.com/captradeoff/d-sys-wiki/issues). |
| 55 | +1. **report issues**: [open an issue](https://github.com/captradeoff/d-sys-wiki/issues) |
61 | 56 |
|
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 |
| 57 | +2. **submit content**: |
| 58 | + - fork the repo |
| 59 | + - create a branch |
| 60 | + - edit markdown in `wiki/` |
| 61 | + - submit pull request |
67 | 62 |
|
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 |
| 63 | +3. **guidelines**: |
| 64 | + - write clearly |
| 65 | + - include examples |
| 66 | + - cite sources |
| 67 | + - follow existing format |
73 | 68 |
|
74 | | -## 🏗️ Project Structure |
| 69 | +## 🏗️ project structure |
75 | 70 |
|
76 | 71 | ``` |
77 | 72 | 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 |
| 73 | +├── wiki/ # docs source files |
| 74 | +│ ├── index.md # home page |
| 75 | +│ ├── about/ # about section |
| 76 | +│ ├── fundamentals/ # concepts |
| 77 | +│ └── img/ # images |
| 78 | +├── mkdocs.yml # config |
| 79 | +├── CNAME # domain config |
| 80 | +└── LICENSE # mit license |
86 | 81 | ``` |
87 | 82 |
|
88 | | -## 📄 License |
| 83 | +## 📄 license |
89 | 84 |
|
90 | | -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 85 | +mit license - see [license](LICENSE) file. |
91 | 86 |
|
92 | | -## 📬 Contact |
| 87 | +## 📬 contact |
93 | 88 |
|
94 | | -- GitHub: [@captradeoff](https://github.com/captradeoff) |
95 | | -- Twitter/X: [@captradeoff](https://x.com/captradeoff) |
| 89 | +- github: [@captradeoff](https://github.com/captradeoff) |
| 90 | +- twitter/x: [@captradeoff](https://x.com/captradeoff) |
0 commit comments