Create a blog post

If you have an interesting, fun, or practical idea that you want to share with the world, you can write a blog post about it!

Blog posts don’t have to follow strict writing rules or styles. They are a good place for you to have fun talking about Tekton.

This is how:

Set up a local version of the website

1. Fork the documentation repository.

2. Clone the repository to your computer:

   git clone https://github.com/<your-git-username>/website.git
   

3. Install Docker Compose, if it’s not already installed on your computer.

4. Change directory to the repository root and run the website server:

   cd website
   docker-compose up
   

   And wait for the confirmation message to pop up:

   ┌─────────────────────────────────────────────────┐
   │                                                 │
   │   ◈ Server now ready on http://localhost:8888   │
   │                                                 │
   └─────────────────────────────────────────────────┘
   

   Keep the server running while you write your post. Press Ctrl + C to stop it.

5. Open your browser and go to http://localhost:8888.

Draft your blog post

1. Create a folder under content/en/blog/<year>/ with a descriptive name. Lower case, use dashes to separate words.

2. Inside the newly created folder, create a file and add a front matter with the following format:

   ---
   title: Title
   likTitle: Title
   date: <date, for example 2022-10-26>
   author: "Author name"
   description: >
       A heading sentence about your post
   ---
   

3. Save the file as index.md. As soon as you save it a new blog entry is now visible on your browser.

4. Below the front matter, write to your heart’s content. Every time you save, the server automatically builds the page and shows the changes.

If you need some inspiration, you can find examples on the website repository.

Open a PR for review

1. After you complete your blog post, open a Pull Request and wait for it to be reviewed.

2. Your blog post is now public and we are all excited to read it. Congratulations!