09 August 2022

How to contribute

Want to write posts, but don't know how, check out this post.

Sidorenko Konstantin
Sidorenko Konstantin thecampagnards

Contact US

First, contact the main contributors to discuss the topic you want to talk about.

After validation, make a fork of the github project to create your future merger request.

Create you first Post

Checkout the README.md install section, to install everything.

When all is okey, edit the following files:

.
├── assets
│   ├── images
│   │   ├── author
│   │   │   └── sidorenko-konstantin.jpg # 2
│   │   └── thumbnail # 5
│   │       ├── 2022-08-03-golang-anonymous-functions.jpg
│   │       ├── 2022-08-04-golang-project-structure.jpg
│   │       └── 2022-08-08-golang-overview-of-the-go-tooling.png
├── categories # 4
│   ├── ci.md
│   ├── development.md
│   ├── golang.md
│   └── tool.md
├── collections
│   └── _posts # 3
│       ├── 2022-08-03-golang-anonymous-functions.md
│       ├── 2022-08-04-golang-project-structure.md
│       └── 2022-08-08-golang-overview-of-the-go-tooling.md
└── _data
    ├── authors.yml # 1
    ├── menu.yml
    └── social.json
  1. First of all, if you are a new author, add yourself to the list.

    • Example of author:
    example_name:
      name: "Example Name"
      image: assets/images/author/example-name.{png,jpg}
      github: example
      twitter: example # not mandatory
    
  2. Then add your most beautiful picture
  3. You are finally ready to write your post, start your file name with the publicationDate-thenTheMainCategory-andFinallyThePostTitle.md.

    • Add this on the top of the markdown file
    ---
    title: "Your main title"
    date: 2022-08-08T07:49:03+01:00 # on local development change this date to see the post but don't forget to change it
    layout: post
    authors: ["Your author name 1", "Your author name 2"]
    categories: ["Your category 1", "Your category 2"]
    description: Your description
    thumbnail: "assets/images/thumbnail/your-post-file-name.{jpg,png}"
    comments: true # if you want to enable disqus to have comment section on the post
    ---
    
  4. If your post contains a new category add a file in the categories folder

    • Add this on the top of the markdown file
    ---
    layout: category
    title: My new category
    ---
    
  5. Add a 16:9 thumbnail to your article, name it like your post file.

Finally, create your merger request, for review.

Welcome as a new author and thank you for your contributions!

Categories

Blog