Learnk8s website

How to create a new article

1. Make a copy of an existing article:

   cp -r src/existing-article src/new-article
   cd src/new-article

2. Clear the content file:

   echo "Hello world" >content.md

3. Clear the assets directory:

   rm assets/*

4. Rename the title images:

   mv existing-article.png new-article.png
   mv existing-article.svg new-article.svg

5. Adapt the footer content file with the related articles:

   vim content-related.md

6. Adapt the index file of the article (use lots of search/replace):

   vim index.tsx

7. Add the article to src/register.ts:

   vim ../register.ts

8. Verify source code edits by running tests:

   npm test

9. Build and run the website:

   ENVENTBRITE_TOKEN=1 ENVENTBRITE_ORG=1 npm run build && npm start

How to run the website locally

Install dependencies:

npm ci

Build:

ENVENTBRITE_TOKEN=1 ENVENTBRITE_ORG=1 npm run build

or, if you're on Windows:

$Env:ENVENTBRITE_TOKEN=1
$Env:ENVENTBRITE_ORG=1
npm run build

Run:

npm start

The command starts a REPL session.

Type .help to reveal the list of commands available.

Development preview

For each pull request, a development preview is created with Netlify. The link is in the deploy/netlify task on the pull request page on GitHub.

Checking your writing

Grammarly is an app that assesses a piece of writing for common grammar mistakes and offers suggestions for correcting them.

The intent with Grammarly is to reduce the time necessary for code reviews and help us to improve our grammar skills in general at the same time.

Create a Free Grammarly Account

Go to https://www.grammarly.com/signin and create a free Grammarly account.

Check Posts with Grammarly

Prior to submitting a new blog post for review via Pull Request, please make sure that you check the content with Grammarly.

Grammarly currently does not support Markdown file import, so you will need to copy and paste your post content into a new file.

In the My Grammarly, click the New icon to create a file. Then paste the contents of your post into the editor. Fortunately, Grammarly is good at ignoring things like code blocks so you shouldn't need to worry about being repeatedly told that someFunction() { is improper grammar.

When you paste your text, Grammarly sends the content to its servers and runs a grammar check. The number of issues is shown in the bottom right of the app. Critical Issues should be addressed. Advanced Issues are only available to paid users.