README.md

@@ -2,55 +2,63 @@
 
 Repository of the OpenBSD Webzine
 
-# Worflow
+# Workflow
 
-Everything related to writing a new issue is in `issues`.
+Everything related to writing a new issue is under `issues` directory.
 
 ## New issue
 
-- Copy `_template` directory under a name like `issue-X` with `X` being the new issue number.
-- Delete the symlink `current` and make it with the new issue as a target.
+- copy `_template` directory under a name like `issue-X` with `X` being the new issue number
+- delete the symlink `current` and recreate it with the new issue as the target
+
+I.e.
+
+```
+$ cd issues
+$ cp -r _template issue-3
+$ ln -fs issue-3 current
+```
 
 ## Edit an issue
 
-- cd into `issues/current/` and edit files as you need.  Categories that are empty should be commented out using html comments.
-- when you recreate the issues with `make`, the one in development is generated in `../dev/`.
-- use `make test` to automatically copy the current issue in `~/Downloads` and open it in a web browser
+- cd into `issues/current/` and edit files as needed
+- categories that are empty should be commented out using HTML comments
+- when you recreate the issues with `make`, the one in development is generated in `../dev/`
+- use `make test` to automatically copy the current issue to `/tmp/openbsd-webzine` directory and open it in a web browser
 
 # Contributing
 
-Anyone can contribute by doing this:
+Anyone can contribute by doing the following:
 
 - English proofreading
-- Translation into other languages
-- Content contribution
+- translation into other languages
+- content contribution
 
-There are many methods for contributing, here is the list by order of preference (more easier to handle):
+There are many ways to contribute - here is a list by order of preference (easier to handle):
 
-1. make an account on tildegit, fork the project, create a new branch with changes and send us Merge Requests (it's easy once you get how this work. See "Git usage below").
-2. make a local commit from a freshly updated cloned repository and use `git format-patch` to send an email to a contributor (currently solene) so your commit can be merged into the repository easily.
-3. send a simple diff to a contributor.
-4. open an issue.
-5. speak on IRC / XMPP / mail.
+1. make an account on tildegit, fork the project, create a new branch with changes, and send us Pull Requests (it's easy once you get how this work - see "Git usage" below)
+2. make a local commit from a freshly updated cloned repository and use `git format-patch` to send an email to a contributor (currently _solene_) so your commit can be merged into the repository easily
+3. send a simple diff to a contributor
+4. open an issue
+5. speak on IRC / XMPP / email
 
 # What content?
 
 For each issue we will try to write about these topics:
 
-- jobs offers related to OpenBSD (if any)
-- big changes landing in current
-- syspatch and digest of packages updates in -stable
-- developer or professionals using OpenBSD interviews (if any)
+- job offers related to OpenBSD (if any)
+- big changes landing in _-current_
+- syspatch and digest of package updates in _-stable_
+- interviews with developers or professionals using OpenBSD (if any)
 - tips about shell or OpenBSD
 - comments from readers
 - links to OpenBSD content
-- one piece of artwork
-- a few interesting links to social medias
+- a piece of artwork
+- a few interesting links to social media
 
 ## Git usage
 
-Fork this project and clone your own fork.
-Then add the upstream repo.
+Fork this project and clone your own fork, then add the upstream repo.
 
 ```
 $ git clone git@tildegit.org:foo/openbsd-webzine.git
@@ -66,7 +74,7 @@ $ git pull upstream main
 
 You can now edit files.
 
-At last, add modified files and commit : 
+At last, add modified files and commit:
 
 ```
 $ git add issue-*/
@@ -74,5 +82,4 @@ $ git commit -m "message"
 $ git push
 ```
 
-You can now ask for a merge request : 
-Menu > Projects > Merge request tab > New request button
+You can now ask for your Pull Request to get merged.

issues/Makefile

@@ -1,4 +1,4 @@
-TEMPDIR=/tmp/openbsd-webzine/
+TEMPDIR=/tmp/openbsd-webzine
 
 generate-site: clean
 	ls | grep issue- | sort -n | xargs -n 1 tools/make_issue.sh

issues/_index/30_INFOS.html

@@ -1,5 +1,5 @@
 <h2>Infos</h2>
 <div>
-    <p>This webzine is done by volunteers who are passionated about the OpenBSD project development.</p>
+    <p>This webzine is done by volunteers who are passionate about the OpenBSD project development.</p>
     <p>Our goal is to allow people to stay informed about OpenBSD in a cool, fun and instructive way, like reading a regularly issued magazine of one's favorite hobby.</p>
 </div>

issues/_index/60_COMMUNITY.html

@@ -1,8 +1,8 @@
 <h2>Community</h2>
 <div>
-    <p>Looking to get in touch with OpenBSD users? Here is a few ways to join them.</p>
+    <p>Looking to get in touch with OpenBSD users? Here are a few ways to join them.</p>
     <ul>
-        <li><a class="permalink" href="https://www.openbsd.org/mail.html">Official OpenBSD mailing-list</a></li>
+        <li><a class="permalink" href="https://www.openbsd.org/mail.html">Official OpenBSD mailing-lists</a></li>
         <li>IRC: channel <code>#openbsd</code> on irc.libera.chat</li>
         <li>XMPP: room <a href="xmpp:openbsd@chat.si3t.ch?join">openbsd@chat.si3t.ch</a></li>
         <li>Reddit: <a class="permalink" href="https://www.reddit.com/r/openbsd/">Subreddit /r/openbsd/</a></li>

issues/_index/70_CONTRIBUTE.html

@@ -1,4 +1,4 @@
 <h2>How to contribute</h2>
 <div>
-    <p>If you want to contribute to the Webzine, from a simple contribution suggesting a link or a news to a large or regular contribution, we do all the work publicly with git. <a class="permalink" href="https://tildegit.org/solene/openbsd-webzine/">Link to the git repository.</a> </p>
+    <p>If you want to contribute to the Webzine, from a simple contribution suggesting a link or a news to a large or regular contribution, we do all the work publicly with Git. <a class="permalink" href="https://tildegit.org/solene/openbsd-webzine/">Link to the Git repository.</a></p>
 </div>

issues/_template/80_ARTWORK.html

@@ -3,6 +3,6 @@
 <h1>Artworks of the moment</h1>
 <a href="static/images/puffer_city_original.jpg"
     <img src="static/images/puffer_city_small.jpg"
-         alt="A drawing featuring a city viewed from some altitude with many characters looking like OpenBSD mascott."
+         alt="A drawing featuring a city viewed from some altitude with many characters looking like OpenBSD mascot."
          width="100%" /></a-->
 

issues/_template/90_SOCIALMEDIA.html

@@ -1,6 +1,6 @@
 <!-- SECTION -->
 <div class="puffies" aria-hidden="true">🐡🐡🐡</div>
-<h1>On social medias</h1>
+<h1>On social media</h1>
 <ul>
     <li><a href=""></a></li>
 </ul>

issues/issue-1/10_HEADLINES.html

@@ -2,7 +2,6 @@
 <h1>Headlines</h1>
 <ul>
     <li>OpenBSD 7.0 release very soon</li>
-    <li>LibreSSL problem with Let's encrypt certificate</li>
-    <li>First issue of this webzine!! We do have an <a href="atom.xml" class="permalink">Atom</a> feed.</a></li>
+    <li>LibreSSL problem with Let's Encrypt certificates</li>
+    <li>First issue of this webzine!! We do have an <a href="atom.xml" class="permalink">Atom feed</a>.</li>
 </ul>
-

issues/issue-1/30_STABLE.html

@@ -6,6 +6,6 @@
     <li>27 September 2021: Errata #17: libressl</li>
     <li>27 September 2021: Apache2 update</li>
     <li>30 September 2021: Errata #18: libressl fix. Users may not be able to connect to some servers using Let's Encrypt certificates.
-    One of the two root certificates used to sign Let's Encrypt certificates expired.
-    This is due to a bug in LibreSSL triggered by Let's Encrypt certificates being signed by two certificates but one expired.</li>
+    One of the two root certificates used to sign Let's Encrypt certificates has expired.
+    This is due to a bug in LibreSSL triggered by Let's Encrypt certificates being signed by two certificates of which one expired.</li>
 </ul>

issues/issue-1/70_LINKS.html

@@ -4,5 +4,5 @@
 <ul>
     <li><a class="permalink" href="https://n.0x0.st/openbsdnow">OpenBSD Now! Unofficial OpenBSD news, updates and thoughts</a></li>
     <li><a class="permalink" href="https://github.com/ligurio/awesome-openbsd">A curated list of awesome OpenBSD resources</a></li>
-    <li><a class="permalink" href="https://www.openbsd.org/papers/eurobsdcon2021-espie-debug.pdf">Debug Packages in OpenBSD : Marc Espie conference à EuroBSDCon</a> - <a class="permalink" href="https://www.youtube.com/watch?v=pcHn4dl-K5c&list=PLskKNopggjc4dadqaCDmctW-swHPD49td&index=6">video</a></li>
+    <li><a class="permalink" href="https://www.openbsd.org/papers/eurobsdcon2021-espie-debug.pdf">Debug Packages in OpenBSD : Marc Espie - EuroBSDCon conference</a> - <a class="permalink" href="https://www.youtube.com/watch?v=pcHn4dl-K5c&list=PLskKNopggjc4dadqaCDmctW-swHPD49td&index=6">video</a></li>
 </ul>

issues/issue-1/80_ARTWORK.html

@@ -7,6 +7,6 @@
              alt="A drawing featuring a city viewed from some altitude with many characters looking like the OpenBSD mascot."
              width="100%" /></a>
     <p>
-        Artwork originaly found <a class="permalink" href="https://www.openbsd.org/artwork.html">here</a>.
+        Artwork originally found <a class="permalink" href="https://www.openbsd.org/artwork.html">here</a>.
     </p>
 </p>

issues/issue-1/90_SOCIALMEDIA.html

@@ -1,6 +1,6 @@
 <!-- SECTION >
 <div class="puffies" aria-hidden="true">🐡🐡🐡</div>
-<h2>On social medias</h2>
+<h2>On social media</h2>
 <ul>
     <li><a href=""></a></li>
 </ul-->

issues/issue-1/91_QUOTES.html

@@ -4,10 +4,10 @@
 <blockquote>
 <ul>
         <li>if you want something conceptualy less broken, give plan9 a try</li>
-        <li>if you want something more polished, give vim+coreutils a try </li>
-        <li>if you want something convivialist, obenbsd is the best trade off i seen (you can also give try to sbase or 9base)</li> 
+        <li>if you want something more polished, give vim+coreutils a try</li>
+        <li>if you want something convivialist, obenbsd is the best trade off i seen (you can also give try to sbase or 9base)</li>
         <li>if you want something more consistent, let's start our project :)</li>
-        <li>if you want something perfect, let it go :)</li> 
+        <li>if you want something perfect, let it go :)</li>
 </ul>
     -- Marc Chantreux on misc@ <a class="permalink" href="https://marc.info/?l=openbsd-misc&m=163077585122070&w=2">Source</a>
 </blockquote>

issues/issue-2/80_ARTWORK.html

@@ -3,6 +3,6 @@
 <h1>Artworks of the moment</h1>
 <a href="static/images/puffer_city_original.jpg"
     <img src="static/images/puffer_city_small.jpg"
-         alt="A drawing featuring a city viewed from some altitude with many characters looking like OpenBSD mascott."
+         alt="A drawing featuring a city viewed from some altitude with many characters looking like OpenBSD mascot."
          width="100%" /></a-->
 

issues/issue-2/90_SOCIALMEDIA.html

@@ -1,6 +1,6 @@
 <!-- SECTION -->
 <div class="puffies" aria-hidden="true">🐡🐡🐡</div>
-<h1>On social medias</h1>
+<h1>On social media</h1>
 <ul>
     <li><a href=""></a></li>
 </ul>

issues/tools/atom.sh

@@ -36,7 +36,7 @@ for page in ../public/issue-*.html ; do
     <link rel="alternate" type="text/html" href="https://${domain}/${issue}.html" />
     <summary type="html">
     <![CDATA[
-        $(awk 'f;/<h1>/{f=1}' $issue/10_headlines.html)
+        $(awk 'f;/<h1>/{f=1}' $issue/10_HEADLINES.html)
     ]]>
     </summary>
   </entry>

issues/tools/make_issue.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 usage() {
-    echo "./$0 directory"
+    echo "$0 directory"
     exit 1
 }