From 143ae1ac13905d0b2d1fded0f3d64e234e3cc2c1 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Mon, 24 May 2021 09:33:01 +0100 Subject: Reword to british english style --- contact-information.md | 4 ++-- gemfeed/2021-04-24-welcome-to-the-geminispace.md | 4 ++-- gemfeed/2021-05-16-personal-bash-coding-style-guide.md | 16 ++++++++-------- resources.md | 10 +++++----- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/contact-information.md b/contact-information.md index 40b44677..c69cb6ac 100644 --- a/contact-information.md +++ b/contact-information.md @@ -5,9 +5,9 @@ * Secure E-Mail: paul.buetow at protonmail dot com * E-Mail: paul at buetow dot org (forwards to the ProtonMail address) -Why did I just mention 2 E-Mail addresses here? The buetow.org address will always stay. It is my lifetime E-Mail address as I own the domain name. The address will remain even when I decided to change my e-mail provider. +Why did I mention 2 E-Mail addresses here? The buetow.org address will always stay. It is my lifetime E-Mail address as I own the domain name. The address will remain even when I decided to change my e-mail provider. -Use the ProtonMail address if you care about security for now. The address stays valid as long as I am ProtonMail user. Especially if you are ProtonMail user too we could have real E-Mail end-2-end encryption for our conversation. +Use the ProtonMail address if you care about security for now. The address stays valid as long as I am ProtonMail user. Especially if you are ProtonMail user too, we could have real E-Mail end-2-end encryption for our conversation. ## Quick Links diff --git a/gemfeed/2021-04-24-welcome-to-the-geminispace.md b/gemfeed/2021-04-24-welcome-to-the-geminispace.md index 02aa349f..73c41e1f 100644 --- a/gemfeed/2021-04-24-welcome-to-the-geminispace.md +++ b/gemfeed/2021-04-24-welcome-to-the-geminispace.md @@ -44,7 +44,7 @@ All I wanted was to read an interesting article, but after a big advertising pop Around the same time, I discovered a relatively new, more lightweight protocol named Gemini, which does not support all these CPU-intensive features like HTML, JavaScript, and CSS. Also, tracking and ads are unsupported by the Gemini protocol. -The "downside" is that due to the limited capabilities of the Gemini protocol, all sites look very old and spartan. But that is not a downside; that is, in fact, a design choice people made. It is up to the client software how your capsule looks. For example, you could use a graphical client with nice font renderings and colors to improve the appearance. Or you could use a very minimalistic command line black-and-white Gemini client. It's your (the user's) choice. +The "downside" is that due to the limited capabilities of the Gemini protocol, all sites look very old and spartan. But that is not a downside; that is, in fact, a design choice people made. It is up to the client software how your capsule looks. For example, you could use a graphical client with nice font renderings and colours to improve the appearance. Or you could use a very minimalistic command line black-and-white Gemini client. It's your (the user's) choice. [![Screenshot Amfora Gemini terminal client surfing this site](./2021-04-24-welcome-to-the-geminispace/amfora-screenshot.png "Screenshot Amfora Gemini terminal client surfing this site")](./2021-04-24-welcome-to-the-geminispace/amfora-screenshot.png) @@ -52,7 +52,7 @@ Why is there a need for a new protocol? As the modern web is a superset of Gemin ## My own Gemini capsule -As it is effortless to set up and maintain your own Gemini capsule (Gemini server + content composed via the Gemtext markup language), I decided to create my own. What I like about Gemini is that I can use my favorite text editor and get typing. I don't need to worry about the style and design of the presence, and I also don't have to test anything in ten different web browsers. I can only focus on the content! As a matter of fact, I am using the Vim editor + its spellchecker + auto word completion functionality to write this. +As it is effortless to set up and maintain your own Gemini capsule (Gemini server + content composed via the Gemtext markup language), I decided to create my own. What I like about Gemini is that I can use my favourite text editor and get typing. I don't need to worry about the style and design of the presence, and I also don't have to test anything in ten different web browsers. I can only focus on the content! As a matter of fact, I am using the Vim editor + its spellchecker + auto word completion functionality to write this. ## Advantages summarised diff --git a/gemfeed/2021-05-16-personal-bash-coding-style-guide.md b/gemfeed/2021-05-16-personal-bash-coding-style-guide.md index 016f209a..1917f53f 100644 --- a/gemfeed/2021-05-16-personal-bash-coding-style-guide.md +++ b/gemfeed/2021-05-16-personal-bash-coding-style-guide.md @@ -25,13 +25,13 @@ These are my modifications to the Google Guide. ### Shebang -Google recommends using always +Google recommends using always... ``` #!/bin/bash ``` -as the shebang line, but that does not work on all Unix and Unix-like operating systems (e.g., the *BSDs don't have Bash installed to /bin/bash). Better is: +... as the shebang line, but that does not work on all Unix and Unix-like operating systems (e.g., the *BSDs don't have Bash installed to /bin/bash). Better is: ``` #!/usr/bin/env bash @@ -74,7 +74,7 @@ command1 | ### Quoting your variables -Google recommends always quote your variables. Generally, you should do that only for variables where you are unsure about the content/values of the variables (e.g., content is from an external input source and may contain whitespace or other special characters). In my opinion, the code will become quite noisy when you always quote your variables like this: +Google recommends always quote your variables. Generally, it would be best if you did that only for variables where you are unsure about the content/values of the variables (e.g., content is from an external input source and may contain whitespace or other special characters). In my opinion, the code will become quite noisy when you always quote your variables like this: ``` greet () { @@ -118,13 +118,13 @@ addition="$(expr "${X}" + "${Y}")" substitution="$(echo "${string}" | sed -e 's/^foo/bar/')" ``` -I can't entirely agree here. The external commands (especially sed) are much more sophisticated and powerful than the Bash built-in versions. Sed can do much more than the Bash can ever do by itself when it comes to text manipulation (the name "sed" stands for streaming editor, after all). +I can't entirely agree here. The external commands (especially sed) are much more sophisticated and powerful than the built-in Bash versions. Sed can do much more than the Bash can ever do by itself when it comes to text manipulation (the name "sed" stands for streaming editor, after all). -I prefer to do light text processing with the Bash built-ins and more complicated text processing with external programs such as sed, grep, awk, cut, and tr. However, there is also the case of medium-light text processing where I would want to use external programs. That is so because I remember using them better than the Bash built-ins. The Bash can get relatively obscure here (even Perl will be more readable then - Side note: I love Perl). +I prefer to do light text processing with the Bash built-ins and more complicated text processing with external programs such as sed, grep, awk, cut, and tr. However, there is also medium-light text processing where I would want to use external programs. That is so because I remember using them better than the Bash built-ins. The Bash can get relatively obscure here (even Perl will be more readable then - Side note: I love Perl). Also, you would like to use an external command for floating-point calculation (e.g., bc) instead of using the Bash built-ins (worth noticing that ZSH supports built-in floating-points). -I even didn't get started with what you can do with Awk (especially GNU Awk), a fully-fledged programming language. Tiny Awk snippets tend to be used quite often in Shell scripts without honoring the real power of Awk. But if you did everything in Perl or Awk or another scripting language, then it wouldn't be a Bash script anymore, wouldn't it? ;-) +I even didn't get started with what you can do with awk (especially GNU Awk), a fully-fledged programming language. Tiny Awk snippets tend to be used quite often in Shell scripts without honouring the real power of Awk. But if you did everything in Perl or Awk or another scripting language, then it wouldn't be a Bash script anymore, wouldn't it? ;-) ## My additions @@ -163,7 +163,7 @@ variable="$(eval some_function)" ``` -However, if I want to read variables from another file, I don't have to use eval here. I just source the file: +However, if I want to read variables from another file, I don't have to use eval here. I only have to source the file: ``` % cat vars.source.sh @@ -237,7 +237,7 @@ The stdout is always passed as a pipe to the next following stage. The stderr is I often refactor existing Bash code. That leads me to add and removing function arguments quite often. It's pretty repetitive work changing the $1, $2.... function argument numbers every time you change the order or add/remove possible arguments. -The solution is to use of the "assign-then-shift"-method, which goes like this: "local -r var1=$1; shift; local -r var2=$1; shift". The idea is that you only use "$1" to assign function arguments to named (better readable) local function variables. You will never have to bother about "$2" or above. That is very useful when you constantly refactor your code and remove or add function arguments. It's something what I picked up from a colleague (a pure Bash wizard) some time ago: +The solution is to use of the "assign-then-shift"-method, which goes like this: "local -r var1=$1; shift; local -r var2=$1; shift". The idea is that you only use "$1" to assign function arguments to named (better readable) local function variables. You will never have to bother about "$2" or above. That is very useful when you constantly refactor your code and remove or add function arguments. It's something that I picked up from a colleague (a pure Bash wizard) some time ago: ``` some_function () { diff --git a/resources.md b/resources.md index 70a0a25b..c827c8a8 100644 --- a/resources.md +++ b/resources.md @@ -4,7 +4,7 @@ This site contains a list of resources I found helpful. I am not an expert in al The list may not be exhaustive, but I will be adding more in the future. I firmly believe that educating yourself further is one of the most important things to advance. The lists are in random order and reshuffled every time (via *sort -R*) when updates are made. -You won't find any links on this site because, over time, the links will break. Please use your favorite search engine when you are interested in one of the resources... +You won't find any links on this site because, over time, the links will break. Please use your favourite search engine when you are interested in one of the resources... ``` .--. .---. .-. @@ -79,11 +79,11 @@ I didn't read them from the beginning to the end, but I am using them to look up Some of these were in-person with exams; others were online learning lectures only. -* Linux Security and Isolation APIs Training; Michael Kerrisk; 3 day on-site training -* MySQL Deep Dive Workshop; 2 day on-site training +* Linux Security and Isolation APIs Training; Michael Kerrisk; 3-day on-site training +* MySQL Deep Dive Workshop; 2-day on-site training * Protocol buffers; O'Reilly Online * Algorithms Video Lectures; Robert Sedgewick; O'Reilly Online -* Red Hat Certified System Administrator; Course + certification (Although I had the option I decided not to take the next course as it is more effective to self learn what I need) +* Red Hat Certified System Administrator; Course + certification (Although I had the option, I decided not to take the next course as it is more effective to self learn what I need) * Scripting Vim; Damian Conway; O'Reilly Online * The Ultimate Kubernetes Bootcamp; School of Devops; O'Reilly Online * Ultimate Go Programming; Bill Kennedy; O'Reilly Online @@ -100,7 +100,7 @@ Many fiction and non-fiction books I read are not listed here. This site primari I have met many self-taught IT professionals I highly respect. In my own opinion, a formal degree does not automatically qualify a person for a particular job. It is more about how you educate yourself further *after* formal education. The pragmatic way of thinking and getting things done do not require a college or university degree. -However, I still believe a degree in Computer Science helps to understand all the theories involved that you would have never learned about otherwise. Isn't it cool to understand how compilers work under the hood (automata theory) even if you are not required to hack the compiler in your current position? You could apply the same theory for other things too. This was just *one* example. +However, I still believe a degree in Computer Science helps to understand all the theories involved that you would have never learned otherwise. Isn't it cool to understand how compilers work under the hood (automata theory) even if you are not required to hack the compiler in your current position? You could apply the same theory for other things too. This was just *one* example. * One year Student exchange program in OH, USA * German School Majors (Abitur), focus areas: German and Mathematics -- cgit v1.2.3