blog-contributions/README.md

63 lines
3.0 KiB
Markdown
Raw Normal View History

2024-07-25 12:23:36 +02:00
# How to contribute
2024-07-25 12:59:28 +02:00
## If you want to edit one of my existing blogposts:
- fork the repository
- edit what you want to edit, from the forked repository
- create a PR, and wait for me to merge it. (feel free to ping me on matrix about it)
## If you want to create a new blogpost:
2024-07-25 13:01:46 +02:00
yes, i pay in moneros, for well made, complete blogpost contributions
Let's say between 10eur and 50eur per blogpost, depending on the complexity
2024-07-25 13:13:48 +02:00
[b]Sidenote: i do not accept any unnecessary technical complication, keep it concise and simplify it as much as possible. Any technical complication must be justified with graphs if needed.[/b]
2024-07-25 12:59:28 +02:00
```
2024-07-25 13:10:09 +02:00
IMPORTANT PARTS OF THE BLOG FOLDER STRUCTURE :
2024-07-25 13:13:48 +02:00
├── assets <--- blog assets, maybe add your profile picture in the img folder if you want
2024-07-25 13:10:09 +02:00
│   ├── css
│   ├── fonts.old
│   ├── img
│   ├── js
│   └── webfonts
2024-07-25 13:13:48 +02:00
├── index.html <--- main blogpost page (no need to edit that)
2024-07-25 13:10:09 +02:00
├── README.md
└── servers
2024-07-25 13:13:48 +02:00
├── 0_anon <--- template tutorial folder
2024-07-25 13:10:09 +02:00
│   └── index.html
2024-07-25 13:13:48 +02:00
├── anonaccess <--- example tutorial folder
│   └── index.html <--- index page of the tutorial (where steps are showcased)
│   └── 0.png <--- images needed for the tutorial
2024-07-25 13:10:09 +02:00
│   └── 1.png
│   └── 2.png
2024-07-25 13:13:48 +02:00
├── anon.html <--- privacy / anon / deniability tutorials index page, where they are all listed
2024-07-25 13:17:50 +02:00
```
2024-07-25 13:10:09 +02:00
2024-07-25 13:17:50 +02:00
## Prerequisites:
2024-07-25 12:59:28 +02:00
2024-07-25 13:17:50 +02:00
### If you want to do one of the tutorial ideas i already listed in anon.html (the main tutorials index):
2024-07-25 12:59:28 +02:00
2024-07-25 13:17:50 +02:00
you don't need my approval to do it. Just check with me directly to make that you understand what the blogpost idea is, to avoid wasting time doing something wrong.
### If you have a new blogpost idea:
Send me on chat your blogpost idea, and tell me where exactly it's supposed to fit in the blog. (i want to keep a coherent order in my tutorials, let me validate your idea, before actually starting)
### once your blogpost idea is validated: proceed with below:
```
- fork the repository
- go into the /servers/ directory, and copy the "0_anon" template directory into whatever other name you want like "anontuto3"
- then edit the index.html file in /servers/anontuto3/index.html, to at least contain :
- your pseudonym,
- the date
- the title of the page
- a brief description at the top detailing what you're going to showcase, and why it's important
- contextualize what you want to showcase whenever needed, as part of explaining WHY it's important
- then showcase each step to get there:
- state what must be done, and how
- show the commands (copy paste into the <pre><code class="nim"> cmds(multi lines) </pre></code> blocks)
- if there's any GUI to showcase, use a screenshot software like flameshot to showcase what must be done using arrows
- conclude the tutorial stating what the user has accomplished at the end.
- then create the PR (pull request) and ping me about it, so i can review it, merge it and pay you in monero for it.
2024-07-25 12:59:28 +02:00
```