contributions updated + readme

This commit is contained in:
nihilist 2024-12-01 17:47:11 +01:00
parent 4b6c5bb5a9
commit c00f3cf0a8
3 changed files with 74 additions and 41 deletions

View file

@ -78,8 +78,26 @@
<img src="1.png" class="imgRz">
<p>Each tutorial (even if completed) has it's own assigned issue on <a href="http://git.nowherejezfoltodf4jiyl6r56jnzintap5vyjlia7fkirfsnfizflqd.onion/nihilist/blog-contributions/issues">gitea</a>:</p>
<img src="1.5.png" class="imgRz">
<p>You can pick one that you'd like to do, if you see one that has a red cross you can click on it, it will redirect you to it's assigned gitea issue (example: <a href="http://git.nowherejezfoltodf4jiyl6r56jnzintap5vyjlia7fkirfsnfizflqd.onion/nihilist/blog-contributions/issues/61">Easy Private Chats - SimpleX</a> you are free to brainstorm it further like so:</p>
<p>You can pick one that you'd like to do, if you see one that has a red cross you can click on it, it will redirect you to it's assigned gitea issue (example: <a href="http://git.nowherejezfoltodf4jiyl6r56jnzintap5vyjlia7fkirfsnfizflqd.onion/nihilist/blog-contributions/issues/61">Easy Private Chats - SimpleX</a>. If there is no todolist on each assigned gitea issue, you are free to brainstorm it like so:</p>
<img src="2.png" class="imgRz">
<p>If a blogpost gitea issue doesn't have a todolist yet, please follow this general template to write it:</p>
<pre><code class="nim">
Privacy - Easy Private Chats with SimpleX
To be explained:
- Graph of the targeted setup
- why is this setup relevant ? What are the threats ? What are we trying to achieve (Privacy / Anonymity / Deniability) ?
- what are your options ?
- comparing option A B and C
- In this tutorial we're going to use option B because it is superior due to these criterias blah blah blah
To be showcased:
- how to install the clientside application
- how to install the serverside application
- how to configure the application
- show that it works as intended
</pre></code>
<p>The idea being that each issue needs to have a clear todolist to bring clarity on what needs to be done in it. <b> Please check if the tutorial is already assigned to someone already or not:</b></p>
<img src="3.png" class="imgRz">
<p>At first, I am assigning only <b>one contributor per tutorial</b>, and only <b>one tutorial per contributor</b> at a time, with a <b>default deadline of 1 month</b>. to complete the assigned tutorial. (if you want to extend the deadline, you'll have to contact me first).</p>
@ -131,6 +149,15 @@ Resolving deltas: 100% (1588/1588), done.
[ mainpc ] [ /dev/pts/18 ] [~/Documents]
→ cd blog-contributions
</pre></code>
<p>If you are reusing the repository after you're done sending pull requests, don't forget to do a git pull to make sure you're working on an up-to-date repository, as i am <a href="http://git.nowherejezfoltodf4jiyl6r56jnzintap5vyjlia7fkirfsnfizflqd.onion/nihilist/blog-contributions/commits/branch/main">frequently pushing commits</a>.</p>
<pre><code class="nim">
[ mainpc ] [ /dev/pts/18 ] [blog-contributions]
→ torsocks git pull http://git.nowherejezfoltodf4jiyl6r56jnzintap5vyjlia7fkirfsnfizflqd.onion/6dv9lk1pbaflulau/blog-contributions
</pre></code>
<p>Now that you're on the latest commit, you can start to do your own changes:</p>
<pre><code class="nim">
[ mainpc ] [ /dev/pts/18 ] [~/Documents/blog-contributions]
→ ls
assets index.html opsec productivity pull.sh push.sh pushtoprod.sh README.md
@ -164,7 +191,9 @@ index.html
</pre></code>
<p>and you can also view your edits in real time from your browser of choice, just put the complete path to the index.html file to view it in real time, for me it is as follows: <b>/home/nihilist/Documents/blog-contributions/opsec/newtutorial/index.html</b> (just hit F5 to refresh in the browser, everytime you save (:w) in vim)</p>
<img src="11.png" class="imgRz">
<p>Make sure that you follow the quality standard i described <a href="../tutorial/index.html">here</a>: <b>start with the Why, then the What, then the How</b>. to describe how to do things, you can use images and screenshots like so: </p>
<p>Make sure that you follow the quality standard i described <a href="../tutorial/index.html">here</a>: <b>start with the Why, then the What, then the How</b>. </p>
<p><u>DISCLAIMER:</u> We are not taking any shortcuts in this blog, I expect you to talk about the path, to list the steps that are on that path, <b>and more importantly want you to show the audience how YOU walk that path.</b></p>
<p>For the "How" parts specifically, as you are expected to explain and show the audience how to do things, <b>make sure you use images and screenshots like so:</b> </p>
<pre><code class="nim">
<<b></b>img src="12.png" class="imgRz">
@ -175,9 +204,11 @@ index.html
apt install flameshot -y
flameshot
</pre></code>
<img src="30.png" class="imgRz">
<p>If you are showcasing a complex tutorial please put into a graph what you are talking about. I used to make graphs using yEd Graphs (but it's closed source) so instead as of q3 2024 i'm using Drawio to make them, both tools have got everything you need to write complex graphs.</p>
<p><u>Sidenote:</u> If you are showcasing any IRL steps to make, take pictures to explain what needs to be done, just like how i did when i showcased how to install <a href="../graphene/index.html">GrapheneOS</a>.</p>
<p>If you are showcasing a complex tutorial please make a graph to explain what you are talking about. One graph will convey the equivalent of a wall of text in one clear image, it's a matter of efficiently conveying information to the audience. I used to make graphs using yEd Graphs (but it's closed source) so instead as of q3 2024 i'm using Drawio to make them, both tools have got everything you need to write complex graphs.</p>
<pre><code class="nim">
[ mainpc ] [ /dev/pts/3 ] [blog/opsec/manifesto]
→ apt search draw.io
@ -205,7 +236,7 @@ draw.io/now 24.7.17 amd64 [installed,local]
<img src="37.png" class="imgRz">
<p>But in the end you should have a good looking graph like this one:</p>
<img src="38.png" class="imgRz">
<p>and if there are any commands to be shown, just copy paste from your terminal directly into the index.html file, into the <b>pre code blocks</b>:</p>
<p>and if there are any commands (or terminal output) to be shown, <b>copy paste from your terminal directly into the index.html file</b> as this is going to help us save some disk space, into the <b>pre code blocks</b>:</p>
<pre><code class="nim">
<<b></b>pre><<b></b>code class="nim">
[ mainpc ] [ /dev/pts/20 ] [~/Nextcloud/blog]