Patch/copywriting

[lyqht]

Changelog

Chapter 1

• refactor retrieveNotes to be more readable
• grammar, spelling and rephrasing edits
• added link to “The basic template for a Node.js project with Express and Pug”
• added bash command to inspect tar
• added example link + screenshot of container image uploaded on dockerhub
• added instructions to address open issue Looks for /data/db folder when looking locally #4

Chapter 2

• added custom graphics
  • diagram for Kubernetes resource categories overview
  • diagram for what is a Pod
• grammar, spelling and rephrasing edits
• Under “Defining a Service” section,
  • removed a duplicated part on “where you should save the definition as it is a best practice” → it is already mentioned before.
  • felt that the 3 dash separation instructions to be a bit confusing, so I rewrote that portion significantly.

Chapter 3

• Link for “The application that you're about to scale is already deployed in the cluster” was pointing to "Developing and deploying Spring Boot microservices on Kubernetes” guide. Changed this to point to Chapter 2 link instead.
• grammar, spelling and rephrasing edits

Chapter 4

• grammar, spelling and rephrasing edits
• added screenshot of eks aws console having the cluster created
• added section on installing aws-cli to verify that the user is authenticated and able to get eks clusters
• rephrased section on calculating the number of knote pods that can be spurned up

---

Notes to Project maintainers:

• In Chapter 2 onwards, we have been telling readers that the application is available from Docker as:

  • learnk8s/knote-js:1.0.0 or
  • learnk8s/knote-js:2.0.0

  → it is up to y’all if you folks want to release 1.0.1 & 2.0.1 containing the dependency updates, or replace the existing version.

• Please check the following in Chapter 2

  • the content of assets/service.svg is the same as assets/service-with-ports.svg → from reading the article, it feels that it is intended to be different.
  • the pro tip section on kubectl explain service.spec.type is cut off a little, so I changed that from an inline code to block code. please help to check if later it still renders as intended.

• Comments on Chapter 3

  • From what I understand, the article’s intent was for teaching the importance of statelessness and the concepts of Scaling in Kubernetes. I think the article delivered these 2 intents very well, but the frequent mentions of how the reader has learnt how to refactor the app to include MinIO was a bit confusing for me.
    • As a reader, I felt that I didn’t really learn much about the refactoring portion, since I’m provided a container image that already contains the refactored code.
    • While I could select & compare files from Folder 03 to Folder 04 using VSC, I’m not sure if most readers would know how to do this.
    • Even if the reader knows to select & compare like this, if they have not worked with storage buckets, they may not understand concepts like bucket, buffer, as well as why the changes in the multer option from a static folder path to memory storage & the new endpoint is required.
    • While we could include a short explanation on the changes, this may prolong the article unnecessarily.
  • I suggest that we don’t emphasize on the fact that the user has learnt how to refactor the code. We could phrase the scenario in the way that they have a teammate who has already helped to refactor the application code, but the reader has to know how to scale the app for the team.

[danielepolencic]

This is a limitation of our markdown engine, but the blockquote will break with the current change as the triple ticks are rendered as a full editor.