From 83c134bddfa3e42bb4dbe675fe478e4e40975ea9 Mon Sep 17 00:00:00 2001 From: Raf Czlonka Date: Fri, 1 Oct 2021 01:11:00 +0100 Subject: [PATCH 1/7] Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.'). --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 932fe19..89c1ddf 100644 --- a/README.md +++ b/README.md @@ -2,55 +2,55 @@ 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 ## 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) +- job 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) +- 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 +66,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-*/ -- 2.34.1 From 88fa426855b2e385187393424c4436e8f9d57d81 Mon Sep 17 00:00:00 2001 From: Raf Czlonka Date: Fri, 1 Oct 2021 01:15:29 +0100 Subject: [PATCH 2/7] "Merge Request" is a GitLab term --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 89c1ddf..1d432bb 100644 --- a/README.md +++ b/README.md @@ -74,5 +74,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. -- 2.34.1 From 59555ff6583f25e2ab45588d490cdac6d184d082 Mon Sep 17 00:00:00 2001 From: Raf Czlonka Date: Fri, 1 Oct 2021 01:22:40 +0100 Subject: [PATCH 3/7] Minor Markdown improvements --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1d432bb..a653862 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,14 @@ Everything related to writing a new issue is under `issues` directory. - 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 needed @@ -29,7 +37,7 @@ Anyone can contribute by doing the following: 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 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 +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 @@ -39,8 +47,8 @@ There are many ways to contribute - here is a list by order of preference (easie For each issue we will try to write about these topics: - job offers related to OpenBSD (if any) -- big changes landing in current -- syspatch and digest of package updates in -stable +- 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 -- 2.34.1 From cb419db537f227cac14a23b9ad549706366d3057 Mon Sep 17 00:00:00 2001 From: Raf Czlonka Date: Fri, 1 Oct 2021 01:26:50 +0100 Subject: [PATCH 4/7] Remove superfluous slashes --- issues/Makefile | 2 +- issues/tools/make_issue.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/issues/Makefile b/issues/Makefile index 792fa91..e89d520 100644 --- a/issues/Makefile +++ b/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 diff --git a/issues/tools/make_issue.sh b/issues/tools/make_issue.sh index 4a92103..2a08be8 100755 --- a/issues/tools/make_issue.sh +++ b/issues/tools/make_issue.sh @@ -1,7 +1,7 @@ #!/bin/sh usage() { - echo "./$0 directory" + echo "$0 directory" exit 1 } -- 2.34.1 From 3ec8f1dccedcecda348fd6f53a83e97760715975 Mon Sep 17 00:00:00 2001 From: Raf Czlonka Date: Fri, 1 Oct 2021 02:05:14 +0100 Subject: [PATCH 5/7] Fix spelling and capitalisation --- issues/_index/30_INFOS.html | 2 +- issues/_index/60_COMMUNITY.html | 4 ++-- issues/_index/70_CONTRIBUTE.html | 2 +- issues/_template/80_ARTWORK.html | 2 +- issues/_template/90_SOCIALMEDIAS.html | 2 +- issues/issue-1/10_headlines.html | 3 +-- issues/issue-1/30_STABLE.html | 4 ++-- issues/issue-1/70_LINKS.html | 2 +- issues/issue-1/80_ARTWORK.html | 2 +- issues/issue-1/90_SOCIALMEDIAS.html | 2 +- issues/issue-1/91_QUOTES.html | 6 +++--- issues/issue-2/80_ARTWORK.html | 2 +- issues/issue-2/90_SOCIALMEDIAS.html | 2 +- 13 files changed, 17 insertions(+), 18 deletions(-) diff --git a/issues/_index/30_INFOS.html b/issues/_index/30_INFOS.html index 67f4db4..b275b99 100644 --- a/issues/_index/30_INFOS.html +++ b/issues/_index/30_INFOS.html @@ -1,5 +1,5 @@

Infos

-

This webzine is done by volunteers who are passionated about the OpenBSD project development.

+

This webzine is done by volunteers who are passionate about the OpenBSD project development.

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.

diff --git a/issues/_index/60_COMMUNITY.html b/issues/_index/60_COMMUNITY.html index 7628677..4b857f1 100644 --- a/issues/_index/60_COMMUNITY.html +++ b/issues/_index/60_COMMUNITY.html @@ -1,8 +1,8 @@

Community

-

Looking to get in touch with OpenBSD users? Here is a few ways to join them.

+

Looking to get in touch with OpenBSD users? Here are a few ways to join them.

    -
    • +
  • IRC: channel #openbsd on irc.libera.chat
  • XMPP: room openbsd@chat.si3t.ch
  • Reddit:
    • diff --git a/issues/_index/70_CONTRIBUTE.html b/issues/_index/70_CONTRIBUTE.html index 3f2f9fb..5ea7506 100644 --- a/issues/_index/70_CONTRIBUTE.html +++ b/issues/_index/70_CONTRIBUTE.html @@ -1,4 +1,4 @@

    How to contribute

    -

    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.

    +

    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.

    diff --git a/issues/_template/80_ARTWORK.html b/issues/_template/80_ARTWORK.html index 2a496c3..46f8040 100644 --- a/issues/_template/80_ARTWORK.html +++ b/issues/_template/80_ARTWORK.html @@ -3,6 +3,6 @@

    Artworks of the moment

    diff --git a/issues/_template/90_SOCIALMEDIAS.html b/issues/_template/90_SOCIALMEDIAS.html index bf9b8d4..b543a01 100644 --- a/issues/_template/90_SOCIALMEDIAS.html +++ b/issues/_template/90_SOCIALMEDIAS.html @@ -1,6 +1,6 @@ -

    On social medias

    +

    On social media

     diff --git a/issues/issue-1/10_headlines.html b/issues/issue-1/10_headlines.html index d0bb05c..e81a65b 100644 --- a/issues/issue-1/10_headlines.html +++ b/issues/issue-1/10_headlines.html @@ -2,7 +2,6 @@

    Headlines

    • OpenBSD 7.0 release very soon
      • -
    • LibreSSL problem with Let's encrypt certificate
      • +
    • LibreSSL problem with Let's Encrypt certificates
    • First issue of this webzine!! We do have an feed.
    - diff --git a/issues/issue-1/30_STABLE.html b/issues/issue-1/30_STABLE.html index d91471d..bc25110 100644 --- a/issues/issue-1/30_STABLE.html +++ b/issues/issue-1/30_STABLE.html @@ -6,6 +6,6 @@
  • 27 September 2021: Errata #17: libressl
  • 27 September 2021: Apache2 update
  • 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.
    • + 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.
diff --git a/issues/issue-1/70_LINKS.html b/issues/issue-1/70_LINKS.html index 71cf59d..71d5a7c 100644 --- a/issues/issue-1/70_LINKS.html +++ b/issues/issue-1/70_LINKS.html @@ -4,5 +4,5 @@ diff --git a/issues/issue-1/80_ARTWORK.html b/issues/issue-1/80_ARTWORK.html index 8f2547e..39bbfa9 100644 --- a/issues/issue-1/80_ARTWORK.html +++ b/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%" />

- Artwork originaly found . + Artwork originally found .

diff --git a/issues/issue-1/90_SOCIALMEDIAS.html b/issues/issue-1/90_SOCIALMEDIAS.html index 06f20a2..5011b23 100644 --- a/issues/issue-1/90_SOCIALMEDIAS.html +++ b/issues/issue-1/90_SOCIALMEDIAS.html @@ -1,6 +1,6 @@ diff --git a/issues/issue-1/91_QUOTES.html b/issues/issue-1/91_QUOTES.html index 0f34c6e..de67c79 100644 --- a/issues/issue-1/91_QUOTES.html +++ b/issues/issue-1/91_QUOTES.html @@ -4,10 +4,10 @@
  • if you want something conceptualy less broken, give plan9 a try
    • -
  • if you want something more polished, give vim+coreutils a try
    • -
  • if you want something convivialist, obenbsd is the best trade off i seen (you can also give try to sbase or 9base)
    • +
  • if you want something more polished, give vim+coreutils a try
    • +
  • if you want something convivialist, obenbsd is the best trade off i seen (you can also give try to sbase or 9base)
  • if you want something more consistent, let's start our project :)
    • -
  • if you want something perfect, let it go :)
    • +
  • if you want something perfect, let it go :)
-- Marc Chantreux on misc@
diff --git a/issues/issue-2/80_ARTWORK.html b/issues/issue-2/80_ARTWORK.html index 2a496c3..46f8040 100644 --- a/issues/issue-2/80_ARTWORK.html +++ b/issues/issue-2/80_ARTWORK.html @@ -3,6 +3,6 @@

Artworks of the moment

diff --git a/issues/issue-2/90_SOCIALMEDIAS.html b/issues/issue-2/90_SOCIALMEDIAS.html index bf9b8d4..b543a01 100644 --- a/issues/issue-2/90_SOCIALMEDIAS.html +++ b/issues/issue-2/90_SOCIALMEDIAS.html @@ -1,6 +1,6 @@ -

On social medias

+

On social media

 -- 2.34.1 From 243374b425ff6dde73a76d072214ea03ff2997e9 Mon Sep 17 00:00:00 2001 From: Raf Czlonka Date: Fri, 1 Oct 2021 02:13:15 +0100 Subject: [PATCH 6/7] Fix structure - capitalise HEADLINES like the other sections already are - SOCIALMEDIA is already plural - "media" is a plural form of "medium" --- issues/_template/{10_headlines.html => 10_HEADLINES.html} | 0 issues/_template/{90_SOCIALMEDIAS.html => 90_SOCIALMEDIA.html} | 0 issues/issue-1/{10_headlines.html => 10_HEADLINES.html} | 0 issues/issue-1/{90_SOCIALMEDIAS.html => 90_SOCIALMEDIA.html} | 0 issues/issue-2/{10_headlines.html => 10_HEADLINES.html} | 0 issues/issue-2/{90_SOCIALMEDIAS.html => 90_SOCIALMEDIA.html} | 0 issues/tools/atom.sh | 2 +- 7 files changed, 1 insertion(+), 1 deletion(-) rename issues/_template/{10_headlines.html => 10_HEADLINES.html} (100%) rename issues/_template/{90_SOCIALMEDIAS.html => 90_SOCIALMEDIA.html} (100%) rename issues/issue-1/{10_headlines.html => 10_HEADLINES.html} (100%) rename issues/issue-1/{90_SOCIALMEDIAS.html => 90_SOCIALMEDIA.html} (100%) rename issues/issue-2/{10_headlines.html => 10_HEADLINES.html} (100%) rename issues/issue-2/{90_SOCIALMEDIAS.html => 90_SOCIALMEDIA.html} (100%) diff --git a/issues/_template/10_headlines.html b/issues/_template/10_HEADLINES.html similarity index 100% rename from issues/_template/10_headlines.html rename to issues/_template/10_HEADLINES.html diff --git a/issues/_template/90_SOCIALMEDIAS.html b/issues/_template/90_SOCIALMEDIA.html similarity index 100% rename from issues/_template/90_SOCIALMEDIAS.html rename to issues/_template/90_SOCIALMEDIA.html diff --git a/issues/issue-1/10_headlines.html b/issues/issue-1/10_HEADLINES.html similarity index 100% rename from issues/issue-1/10_headlines.html rename to issues/issue-1/10_HEADLINES.html diff --git a/issues/issue-1/90_SOCIALMEDIAS.html b/issues/issue-1/90_SOCIALMEDIA.html similarity index 100% rename from issues/issue-1/90_SOCIALMEDIAS.html rename to issues/issue-1/90_SOCIALMEDIA.html diff --git a/issues/issue-2/10_headlines.html b/issues/issue-2/10_HEADLINES.html similarity index 100% rename from issues/issue-2/10_headlines.html rename to issues/issue-2/10_HEADLINES.html diff --git a/issues/issue-2/90_SOCIALMEDIAS.html b/issues/issue-2/90_SOCIALMEDIA.html similarity index 100% rename from issues/issue-2/90_SOCIALMEDIAS.html rename to issues/issue-2/90_SOCIALMEDIA.html diff --git a/issues/tools/atom.sh b/issues/tools/atom.sh index 587b448..851fa9d 100755 --- a/issues/tools/atom.sh +++ b/issues/tools/atom.sh @@ -36,7 +36,7 @@ for page in ../public/issue-*.html ; do /{f=1}' $issue/10_headlines.html) + $(awk 'f;/

/{f=1}' $issue/10_HEADLINES.html) ]]>

-- 2.34.1 From 2e9472a4128064cee634a75b6d963200a7b0f693 Mon Sep 17 00:00:00 2001 From: Raf Czlonka Date: Fri, 1 Oct 2021 02:30:06 +0100 Subject: [PATCH 7/7] Remove doubled anchor closing tag ('') --- issues/issue-1/10_HEADLINES.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/issues/issue-1/10_HEADLINES.html b/issues/issue-1/10_HEADLINES.html index e81a65b..0b53518 100644 --- a/issues/issue-1/10_HEADLINES.html +++ b/issues/issue-1/10_HEADLINES.html @@ -3,5 +3,5 @@
  • OpenBSD 7.0 release very soon
  • LibreSSL problem with Let's Encrypt certificates
    • -
  • First issue of this webzine!! We do have an feed.
    • +
  • First issue of this webzine!! We do have an .
-- 2.34.1